Skip to content

Split up user/developer docs #5070

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
agjohnson opened this issue Jan 4, 2019 · 4 comments
Closed

Split up user/developer docs #5070

agjohnson opened this issue Jan 4, 2019 · 4 comments
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code Needed: documentation Documentation is required

Comments

@agjohnson
Copy link
Contributor

We're currently running into some information architecture issues, where user related docs are being lumped in with what would be a developer related doc page. In general, having our developer docs part of our user docs is also confusing for users as this is a bit of information overload.

I purpose:

  • We split up user docs to a docs/users
  • User docs would be extendable, using some of the patterns i've worked out for extendable Sphinx docs
  • Our commercial side would override necessary pieces to user docs so that our docs don't need preface of "If you are a commercial customer, here is how this feature works ..."
  • Our developer docs would split to docs/developers
  • Information on contributing and architecture go in developer docs
  • We start hosting a more complex documentation set under docs.readthedocs.com, docs.readthedocs.io can still be user docs
  • docs.readthedocs.com will dog food our features on subprojects, subproject search, and API usage
  • docs.readthedocs.com is a landing page project that will point to all of our documentation projects, so eventually we'll even have docs.readthedocs.com/projects/theme/en/latest, etc.
  • Also, our private docs will be hosted on docs.readthedocs.com?
@agjohnson agjohnson added the Needed: design decision A core team decision is required label Jan 4, 2019
@ericholscher
Copy link
Member

👍 on this. I think it needs a bit more thought about how to structure it, but definitely think dogfooding all our features is an obvious win. It also would make our shortcomings around subprojects much more obvious, and likely spur us to fix them for us & our users.

@agjohnson agjohnson added this to the Better user documentation milestone Feb 4, 2019
@agjohnson agjohnson added the Accepted Accepted issue on our roadmap label Feb 4, 2019
@agjohnson
Copy link
Contributor Author

I'd like to focus on this in the near term, having good docs in place would be helpful for commercial projects.

I'll start by restarting our .com POC docs, complete with landing page and such. We have a few new features that make this easier now.

@agjohnson agjohnson added Improvement Minor improvement to code and removed Needed: design decision A core team decision is required labels Feb 4, 2019
@davidfischer
Copy link
Contributor

davidfischer commented Jul 27, 2019

We split up user docs to a docs/users
Our developer docs would split to docs/developers
Information on contributing and architecture go in developer docs

I believe that these are mostly done in #5819. All the developer docs now live under docs/development, the are no longer linked from the front page directly (one must click to "contributing" first, and all the other docs are user facing.

@humitos
Copy link
Member

humitos commented Jan 27, 2022

Most of this was done by @stsewd with https://dev.readthedocs.io/en/latest/, right? Should we close this issue?

@humitos humitos closed this as completed Feb 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

4 participants