Skip to content
This repository has been archived by the owner on Jun 2, 2020. It is now read-only.

Gather and link existing docs and resources #68

Merged
merged 17 commits into from
Jun 12, 2018

Commits on May 26, 2018

  1. Fill in lots of links to external content

    Plus just a little bit of original text to fill things in a bit. Also has a few rough cuts at "concepts" docs so other people can start expanding them or adding more.
    
    License: MIT
    Signed-off-by: Rob Brackett <rob@robbrackett.com>
    Mr0grog committed May 26, 2018
    Configuration menu
    Copy the full SHA
    71afae4 View commit details
    Browse the repository at this point in the history
  2. Hack up existing theme to work slightly better

    - Hide the search bar (search doesn't work)
    - Make menu work on small screens
    - Use IPFS colors
    - Create menu of all the external links and pages using Hugo's menu system
    
    The theming work here is pretty gross and definitely needs to be totally re-done. This is really a bunch of quick hacks to get things vaguely functional.
    
    License: MIT
    Signed-off-by: Rob Brackett <rob@robbrackett.com>
    Mr0grog committed May 26, 2018
    Configuration menu
    Copy the full SHA
    621cdb7 View commit details
    Browse the repository at this point in the history
  3. Add all the old example docs as draft content

    These used to get rendered at the old docs site using the example "viewer" app. I have two main concerns there:
    
    - It doesn't fit with the rest of the docs well
    - It's yet another thing to maintain
    
    So I've dropped all those docs in as normal Hugo pages here. They're all marked as drafts so they don't actually render out in a normal build, though. (The old "viewer" versions of them are also still all linked from the `/guides/examples` page, so the *content* here is still accessible.)
    
    License: MIT
    Signed-off-by: Rob Brackett <rob@robbrackett.com>
    Mr0grog committed May 26, 2018
    Configuration menu
    Copy the full SHA
    ff5bac9 View commit details
    Browse the repository at this point in the history

Commits on May 31, 2018

  1. Fix link in usage doc

    License: MIT
    Signed-off-by: Rob Brackett <rob@robbrackett.com>
    Mr0grog committed May 31, 2018
    Configuration menu
    Copy the full SHA
    9514583 View commit details
    Browse the repository at this point in the history
  2. Update .editorconfig for more file types

    License: MIT
    Signed-off-by: Rob Brackett <rob@robbrackett.com>
    Mr0grog committed May 31, 2018
    Configuration menu
    Copy the full SHA
    e6060ac View commit details
    Browse the repository at this point in the history
  3. Reorder menus

    License: MIT
    Signed-off-by: Rob Brackett <rob@robbrackett.com>
    Mr0grog committed May 31, 2018
    Configuration menu
    Copy the full SHA
    cc2ecc8 View commit details
    Browse the repository at this point in the history
  4. Manage build process in makefile

    License: MIT
    Signed-off-by: Rob Brackett <rob@robbrackett.com>
    Mr0grog committed May 31, 2018
    Configuration menu
    Copy the full SHA
    ade0594 View commit details
    Browse the repository at this point in the history

Commits on Jun 1, 2018

  1. Move content under 4 main sections

    I'm hoping this lends a little more clarity and organization to things where we had a lot of major topic areas before. We still have those same sections, but now they are organized under 4 main sections:
    
    1. Introduction
    2. Guides
        - Concepts
        - Guides
        - Examples
    3. Reference
        - Commands & API
        - Go Implementation
        - JS Implementation
        - Specifications & Planning
    4. Community
        - Applications
        - Community
        - Get Involved
        - Related Projects
    
    License: MIT
    Signed-off-by: Rob Brackett <rob@robbrackett.com>
    Mr0grog committed Jun 1, 2018
    Configuration menu
    Copy the full SHA
    d21a73b View commit details
    Browse the repository at this point in the history
  2. Move generated assets to static-build directory

    We can split assets that are actually native to this repo from assets that are generated (by copying from a module or by building Less/JS code) since Hugo supports multiple, layered static directories. Static assets that belong in source control now go in `static`, while generated assets go in `static-build`.
    Mr0grog committed Jun 1, 2018
    Configuration menu
    Copy the full SHA
    77b54b8 View commit details
    Browse the repository at this point in the history
  3. Add ipfs/notes repo to community section

    License: MIT
    Signed-off-by: Rob Brackett <rob@robbrackett.com>
    Mr0grog committed Jun 1, 2018
    Configuration menu
    Copy the full SHA
    ee05b05 View commit details
    Browse the repository at this point in the history
  4. Incorparate @Stebalien's updates to usage guide

    Originally from ipfs-inactive/website#253
    
    License: MIT
    Signed-off-by: Rob Brackett <rob@robbrackett.com>
    Mr0grog committed Jun 1, 2018
    Configuration menu
    Copy the full SHA
    84b4ccf View commit details
    Browse the repository at this point in the history
  5. Change make dependencies so CI works

    Also stop pulling in the JS packages since we don't actually *use* the resulting generated docs.
    
    License: MIT
    Signed-off-by: Rob Brackett <rob@robbrackett.com>
    Mr0grog committed Jun 1, 2018
    Configuration menu
    Copy the full SHA
    ebe507b View commit details
    Browse the repository at this point in the history

Commits on Jun 11, 2018

  1. Update HTTP API docs for CIDs and Multiaddr types

    Uses docs generated via ipfs-inactive/http-api-docs#13, which are more accurate about response format and type.
    
    Licese: MIT
    Signed-off-by: Rob Brackett <rob@robbrackett.com>
    Mr0grog committed Jun 11, 2018
    Configuration menu
    Copy the full SHA
    fac31cb View commit details
    Browse the repository at this point in the history
  2. Downgrade Less to v2

    v3 has bugs with multiple plugins; this keeps things simple and matches other IPFS website projects (which are holding back from v3 for the same reason).
    
    Licese: MIT
    Signed-off-by: Rob Brackett <rob@robbrackett.com>
    Mr0grog committed Jun 11, 2018
    Configuration menu
    Copy the full SHA
    610ecdd View commit details
    Browse the repository at this point in the history
  3. Use correct fonts everywhere

    - Drop Roboto
    - Use Montserrat only for headings
    - Use Inter-UI for normal copy
    - Use correct monospace fonts for code smaples, etc.
    
    License: MIT
    Signed-off-by: Rob Brackett <rob@robbrackett.com>
    Mr0grog committed Jun 11, 2018
    Configuration menu
    Copy the full SHA
    abdf6ac View commit details
    Browse the repository at this point in the history
  4. Generate docs for go-ipfs coreapi subpackages

    This is *really* imperfect, but is at least functional and makes critical info accessible for now. Some things that ultimately need cleanup:
    
    - Subpackages should be linked from parent packages instead of being independent
    - Subpackages should be autogenerated while generating the parent
    - Parent docs should have links to the relevant child/subpackage symbols inline (e.g. in function signatures)
    Mr0grog committed Jun 11, 2018
    Configuration menu
    Copy the full SHA
    35429b8 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    ada8aa9 View commit details
    Browse the repository at this point in the history