Skip to content

Create a map of how the docs should look, with the "Single-source documentation" project in mind. #265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
johnnymatthews opened this issue Nov 27, 2019 · 3 comments
Labels
dif/medium Prior experience is likely helpful effort/hours Estimated to take one or several hours kind/architecture Core architecture of project P2 Medium: Good to have, but can wait until someone steps up topic/docs Documentation

Comments

@johnnymatthews
Copy link
Contributor

Note: This issue was opened as a result of the November 2019 close-reading audit captured in ipfs-inactive/docs#326.

As discussed in ipfs-inactive/docs#326 under Content Guidelines, a next-generation hierarchy was proposed for the overall navigation IA of the docs site:

Home
├────── Getting Started
 Quick-win is the name of the game here. We want the reader to be able to go through this section in less than an hour and come out the other end with a solid idea of what IPFS is, how to use it, and why it's important.
├────── Developer Concepts
 Explain difficult or new things that IPFS addresses. This could be things like how it's different than a regular database, or how Filecoin integrates into IPFS.
├────── Community
 Guides, links, and references to documentation, tools, and services create and maintained by the IPFS community. There should also be support links in here that are directed to places like StackOverflow and the IPFS forum.
├────── Guides
 End to end tutorials that walk a user through achieving a particular goal. That can be as simple as setting up a node, uploading a single file, uploading a whole site, or changing a website's name server so that it points to IPFS.
├────── Tools
 Things you can use to interact with IPFS. These things might not necessarily be 100% useful or necessary all the time, but they're available all the same.
└────── APIs
 IPFS has a bunch of different APIs available to developers for various different implementations. Each API needs a getting started guide, API references, and an examples section.

However, implementing this new IA will require significant rewriting of existing content, as well as creating new documents and articles to fill in the holes. A more in-depth map should be created before we start writing and editing content.

Let's use this issue as a holding pen for discussing the timeline and necessary steps for implementing a next-gen navigation IA, starting with generating/improving content labeled for new content or content enhancement.

@johnnymatthews johnnymatthews self-assigned this Nov 27, 2019
@jessicaschilling jessicaschilling changed the title Implement the more structured hierarchy. Implement the next round of navigation IA Nov 28, 2019
@jessicaschilling
Copy link
Contributor

See below for @johnnymatthews' mind map of the concepts organized above:
image

@jessicaschilling jessicaschilling changed the title Implement the next round of navigation IA Implement the next round of navigation IA after content exists to support it Dec 16, 2019
@hsanjuan hsanjuan transferred this issue from ipfs-inactive/docs May 22, 2020
@johnnymatthews johnnymatthews added the need/triage Needs initial labeling and prioritization label Jun 6, 2020
@johnnymatthews
Copy link
Contributor Author

johnnymatthews commented Jun 17, 2020

This map was created back in November. I've since found out how deep the IPFS rabbit hole goes, so the map is horribly out of date and need re-drawing.

The new re-drawn map should take considerations the from Single-source documentation project.

@johnnymatthews johnnymatthews changed the title Implement the next round of navigation IA after content exists to support it Create a map of how the docs should look, with all the efforts from "Automate the docs" included in said map. Jun 17, 2020
@johnnymatthews johnnymatthews changed the title Create a map of how the docs should look, with all the efforts from "Automate the docs" included in said map. Create a map of how the docs should look, with the "Single-source documentation" project in mind. Jun 17, 2020
@johnnymatthews johnnymatthews added dif/medium Prior experience is likely helpful effort/hours Estimated to take one or several hours kind/architecture Core architecture of project P2 Medium: Good to have, but can wait until someone steps up topic/docs Documentation and removed need/triage Needs initial labeling and prioritization labels Jun 17, 2020
@BlocksOnAChain
Copy link

we shouldn’t do this, since we changed the approach after the reorg we did - @johnnymatthews

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dif/medium Prior experience is likely helpful effort/hours Estimated to take one or several hours kind/architecture Core architecture of project P2 Medium: Good to have, but can wait until someone steps up topic/docs Documentation
Projects
None yet
Development

No branches or pull requests

4 participants