Skip to content

Rearrange development docs ToC #3240

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

Merged
merged 1 commit into from
Nov 10, 2017
Merged

Conversation

techtonik
Copy link
Contributor

This is to make architecture the top link after changelog
and installation instructions. Also moves API to the bottom,
because it stands out of the reading flow, which is:

  • see if the development thing you think about is already done
  • launch installation if you're going to fix anything
  • (or) read about archtecture
  • about testing, probably installation is ready
  • how to sync docs
  • standards, etc.
  • components (should be linked from archtecture)
  • everything else
  • leave API pages open

This is to make architecture the top link after changelog
and installation instructions. Also moves API to the bottom,
because it stands out of the reading flow, which is:

- see if the development thing you think about is already done
- launch installation if you're going to fix anything
- (or) read about archtecture
- about testing, probably installation is ready
- how to sync docs
- standards, etc.
- components (should be linked from archtecture)
- everything else
- leave API pages open
@ericholscher
Copy link
Member

Great, thanks! I also need to write more architecture docs here, but this is a good step.

We should really break all these docs out into seperate projects probably, to make them more grokable, but that's a longer term issue.

@ericholscher ericholscher merged commit 69837b2 into readthedocs:master Nov 10, 2017
@techtonik techtonik deleted the patch-3 branch November 10, 2017 22:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants