You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We currently have guides on gettings started with Sphinx/Mkdocs, but don't ever describe how to get started using Read the Docs for new users who are completely unfamiliar with RTD. This might be something we wait on for new templates, as we likely want additional screenshots of the UI, and have two separate interfaces currently.
This is a good start, and perhaps might even be sufficient, or could be a base to work from. I feel like we had some additional content in the past, but it doesn't seem very discoverable in our docs if it does still exist.
Some pieces that might be worth adding to our getting started documentation:
Signing up with VCS account and creating your first project from a connected repository
If the user doesn't have a repository to test yet, this is the point where they should do the Sphinx getting started guide
Setting up your project after you've gone through the Sphinx getting started guide
Configuring versions and version privacy
Your first build
Your first build failure
Dealing with common build failures
There is certainly a good amount of user-centric documentation (especially around smaller features) missing in our docs, but to keep scope here low, the goal of this work is to provide users unfamiliar with RTD a full description of getting started.
The text was updated successfully, but these errors were encountered:
We should cover handling build failures. This is a common hurdle we don't have documented
Feature documentation might be better as independent docs instead of guide content. We have localization docs that need updated, and could use independent docs on analytics.
Also, not mentioned yet, we haven't addressed any of the organization/team pieces in our docs at all either -- team management, adding users, etc
We currently have guides on gettings started with Sphinx/Mkdocs, but don't ever describe how to get started using Read the Docs for new users who are completely unfamiliar with RTD. This might be something we wait on for new templates, as we likely want additional screenshots of the UI, and have two separate interfaces currently.
We do have some docs on importing a project:
https://docs.readthedocs.io/en/stable/intro/import-guide.html
This is a good start, and perhaps might even be sufficient, or could be a base to work from. I feel like we had some additional content in the past, but it doesn't seem very discoverable in our docs if it does still exist.
Some pieces that might be worth adding to our getting started documentation:
There is certainly a good amount of user-centric documentation (especially around smaller features) missing in our docs, but to keep scope here low, the goal of this work is to provide users unfamiliar with RTD a full description of getting started.
The text was updated successfully, but these errors were encountered: