Misc documentation cleanup

falconry / falcon

The no-magic web data plane API and microservices framework for Python developers, with a focus on reliability, correctness, and performance at scale.

https://falcon.readthedocs.io/en/stable/

Apache License 2.0

9.53k stars 945 forks source link

Misc documentation cleanup #2318

Open vytas7 opened 2 months ago

vytas7 commented 2 months ago

Documentation improvements and tweaks that are not highest prio, but would be nice to iron out:

[ ] https://falcon.readthedocs.io/en/latest/community/contributing.html#reviews :arrow_left: checkboxes within use the GitHub flavour of Markdown, which does not render exactly the same in the MyST Markdown flavour that Sphinx uses. Check if there is a suitable plugin, or, in the worst case, just convert CONTRIBUTING.md to ordinary bullet lists.

nithin-sudarsan commented 1 month ago

@vytas7 since https://falcon.readthedocs.io/en/latest/community/contributing.html#reviews is a list of points that a reviewer will look for while reviewing a PR, it makes more sense to have them as bullet lists rather than checkboxes (similar to https://falcon.readthedocs.io/en/latest/community/contributing.html#code-style-rules)

nithin-sudarsan commented 1 month ago

@vytas7 please check the above PR and I would appreciate it if you could take some time to review the changes and provide feedback when convenient. Thank you!