-
Notifications
You must be signed in to change notification settings - Fork 23
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
Information architecture experimentation. #348
Conversation
Signed-off-by: John Krug <[email protected]>
✅ Deploy Preview for silly-bunny-8cedd0 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: John Krug <[email protected]>
Signed-off-by: John Krug <[email protected]>
Signed-off-by: John Krug <[email protected]>
Signed-off-by: John Krug <[email protected]>
Signed-off-by: John Krug <[email protected]>
@@ -0,0 +1,23 @@ | |||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't seem to find or visualize the pages that relate to docs/info-arch/doc-types/*
. In my opinion, maybe they aren't needed, docs/info-arch/ia.md
can explain the types, and if they have several sections then the sections should be self-explanatory on the sidebar. If we create an index per Diataxis section, I feel they will be missing entries in the long run.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, I misunderstood where to find them, they are linked from the headers of docs/info-arch/ia.md.
I'm not sure it's easily discoverable that way. I would prefer a link after the section header.
|
||
## Glossary | ||
|
||
Should we have one of these? A set of key terms and their definitions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm ok with both an index/glossary/word cloud, sounds like a feature request issue. On my view, it has low priority though.
Leaving this with no status for a while. I will use some aspects of this again after the /docs reorg/new sidebar/ is complete. |
DO NOT MERGE. Experiment only.
See if this is going to be a useful direction for us.
Trying ideas in the docs to allow exploration of the structure of the docs so a learning path can be plotted by a user (the personas) of the docs.
To have ways apart from the Diataxis sidebar layout to navigate the docs. By persona, by topic, etc. To provide exploration and learning paths.
The idea would be that the entire 'Documentation architecture' hierarchy and content can be programmatically generated. But it can be much simpler than that. What provides the best value solution?
Please take a look at the preview.
https://deploy-preview-348--silly-bunny-8cedd0.netlify.app/next/info-arch/ia