Better autogenerated index file #3447
Conversation
|
In this commit 0fcbe84 is the change, the other changes are from |
readthedocs/doc_builder/base.py
Outdated
| @@ -101,7 +106,8 @@ def create_index(self, extension='md', **__): | |||
|
|
|||
| This is an autogenerated index file. | |||
|
|
|||
| Please create a ``{dir}/index.{ext}`` or ``{dir}/README.{ext}`` file with your own content. | |||
| Please create a ``index.{ext}`` or ``README.{ext}`` file with your own content | |||
There was a problem hiding this comment.
I think it should be an here instead of a since the next word is a vocal.
readthedocs/doc_builder/base.py
Outdated
| @@ -101,7 +106,8 @@ def create_index(self, extension='md', **__): | |||
|
|
|||
| This is an autogenerated index file. | |||
|
|
|||
| Please create a ``{dir}/index.{ext}`` or ``{dir}/README.{ext}`` file with your own content. | |||
| Please create a ``index.{ext}`` or ``README.{ext}`` file with your own content | |||
| under the root directory in your repository (or under ``/docs`` directory). | |||
There was a problem hiding this comment.
I just realized that this could sound repetitive, so maybe it could be better
under the root (or
/docs) directory in your repository.
|
This looks like a good start. We should probably link to some resources that might help folks along, if we really want to make this better. Perhaps our getting started doc guide (http://docs.readthedocs.io/en/latest/getting_started.html)? |
|
|
||
| If you want to use another markup, choose a different builder in your settings. | ||
| Check out our `Getting Started Guide | ||
| <https://docs.readthedocs.io/en/latest/getting_started.html>`_ to become more |
There was a problem hiding this comment.
I'm not sure if the English is right
readthedocs/doc_builder/base.py
Outdated
|
|
||
| If you want to use another markup, choose a different builder in your settings. | ||
| Check out our `Getting Started Guide | ||
| <https://docs.readthedocs.io/en/latest/getting_started.html>`_ to become more | ||
| familiar with Read The Docs. |
There was a problem hiding this comment.
Read the Docs is the brand.
Related issue #3351
Here is how it looks
This image is out of date
