Conversation
Andre601
left a comment
Andre601
left a comment
There was a problem hiding this comment.
Some changes I would like to see addressed.
| @@ -1,60 +1,70 @@ | |||
| # ProperDocs | |||
| ## ProperDocs | |||
There was a problem hiding this comment.
I do not see where changing this from h1 to h2 is any better.
| * YAML-based configuration | ||
| * Plugin system for extending functionality | ||
| * Support for Markdown extensions | ||
| * Built-in themes |
There was a problem hiding this comment.
This is no longer the case. Themes are by default not included anymore and separate.
| - For questions and high-level discussions, use **[Discussions]** on GitHub. | ||
| - For small questions, a good alternative is the **[Chat room]** on | ||
| Gitter/Matrix. | ||
| - For small questions, a good alternative is the **[Chat room]** on Gitter/Matrix. |
There was a problem hiding this comment.
We don't use Gitter or Matrix, but Discord.
|
|
||
| ## License | ||
|
|
||
| ProperDocs is distributed under the **BSD-2-Clause license**. |
There was a problem hiding this comment.
We should link to the file.
| ProperDocs is distributed under the **BSD-2-Clause license**. | |
| ProperDocs is distributed under the [**BSD-2-Clause license**](LICENSE). |
|
|
||
| Everyone interacting in the ProperDocs project's codebases, issue trackers, and | ||
| discussion forums is expected to follow the [PyPA Code of Conduct]. | ||
| All participants in the ProperDocs project are expected to follow the **PyPA Code of Conduct**. |
There was a problem hiding this comment.
PyPA no longer has its own Code of Conduct and moved to the PSF Code of Conduct (Which ironically uses the Material theme and by extension MkDocs, so maybe we can convince them to move?)
Based on this info
Also, we should either adobt our own Code of Conduct, or link and name the PSF one here instead.
2 participants
remove downgrite gorgeus and make more helpfulp