Move known-issues from topics to refs #371
Conversation
There was a problem hiding this comment.
I'm unconvinced that we should set a precedent of including top-level documents outside of the howto/ref/topic hierarchy. Whether it's a "topic guide' could be debated. It might be a better fit in reference material.
p.s. Please don't use such vague commit messages and PR titles as "Doc fixes".
| @@ -74,5 +75,6 @@ Miscellaneous | |||
| ref/index | |||
| howto/index | |||
| faq | |||
| known-issues | |||
There was a problem hiding this comment.
You didn't follow the instructions above: .. Keep this toctree in sync with contents.rst.
There was a problem hiding this comment.
? You mean the ordering?
| - Looking for specific information? Try the :ref:`genindex`, :ref:`modindex`, | ||
| or the detailed :doc:`table of contents <contents>`. | ||
| :doc:`topics section <topics/index>` or detailed :doc:`table of contents | ||
| <contents>`. |
There was a problem hiding this comment.
Nor is the reference material mentioned. This text was ripped straight from Django's documentation. I don't think we need to mention every section here.
There was a problem hiding this comment.
We don't need to mention every section and at first I had it in its own bullet but decided to include "topics" in a bullet about topics. 😄
Also I'm only calling out personal annoyances, not necessarily looking to symmetrize the entire docs.
Lastly, copying from Django is fine but only gets us so far.
aclark4life
changed the title
This comment was marked as resolved.
This comment was marked as resolved.
This PR addresses two issues with the documentation I've noticed: