Repository navigation
Docs/diataxis restructure - #126
Open
AntoninKns wants to merge 3 commits into
Open
AntoninKns wants to merge 3 commits into
AntoninKns wants to merge 3 commits into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reorganizes the documentation following the Diátaxis framework as suggested in #122 . The
documentation/index.mdis split into tutorials, how-to guides, reference and explanation pages, with the MkDocs navigation grouped to match.I did not find any guideline prohibiting the use of LLMs for contributions to this repository, that is why I took the liberty to use Claude Code to help me apply the changes. I read the documentation, did an initial manual split then completed it automatically using Claude Code. I built it and reviewed it locally, tested the links and everything seems fine. I generated the PR description using Claude Code, but entirely reviewed it and edited it manually.
This PR only modifies structure to make review easier. The text is moved verbatim, not rewritten except minor adjustments mentioned below. If this suits you, I will make a further PR with some language changes to follow the Diátaxis framework more strictly.
Structure changes
index.mdis split intotutorials/,how-to/,reference/andexplanation/.mkapiAPI pages sit alongside it in the nav.documentation/mkdocs.yaml): Five top-level groups. How-to Guides is grouped into Set up, Configure, Work with HDX objects (Datasets and Resources sub-groups), Other tools and Examples. API Documentation comes before Breaking Changes under Reference.documentation/index.md: Now the summary plus a link list that mirrors the nav (the old anchor-based table of contents is gone)..gitignore: Ignores the MkDocssite/build output.Changes beyond moving text
#heading, retitled in imperative style (e.g. "Obtain your API Key"). The nav labels match them.framework.md→ install, tutorial → API key, resource operations → dataset resources, changelog → tags. Two anchors were rewritten as relative links.operate-datasets.md/tooperate-datasets/.