search

emmett-framework / emmett

The web framework for inventors
BSD 3-Clause "New" or "Revised" License
1.06k stars 71 forks source link

Index and navigation docs #256

Closed alexandremasbr closed 4 years ago

alexandremasbr commented 4 years ago

Any good project needs a good documentation.

While the docs are quite complete, people stay confusing where to start or continue looking at github code.

So I included a README.md to be a index, and at footer of each md file I appended a next and index urls, so people can navigate easily at the docs.

The index is based on tree.yml, so i think its follows the intentions of author.

gi0baro commented 4 years ago

@alexandremasbr thank you for your proposal, but since now docs are available at https://emmett.sh/docs, I'm gonna reject this