Update contributing.md #241
Conversation
WalkthroughThe documentation has been enhanced with new content to aid contributors. It now includes additional resources to deepen understanding, such as instructions for using Changes
TipsChat with CodeRabbit Bot (
|
| @@ -36,3 +36,18 @@ If you need ideas, you can check out the [help wanted](https://github.com/jxnl/i | |||
| <a href="https://github.com/jxnl/instructor/graphs/contributors"> | |||
| <img src="https://contrib.rocks/image?repo=jxnl/instructor" /> | |||
| </a> | |||
|
|
|||
|
|
|||
| ## Additional Resources | |||
There was a problem hiding this comment.
can you mvoe this above the contributors table and something like
to run the docs pip install requirements-doc.txt and run mkdocs serve -w . to preview the documentation
to improve the legibility of code and content consider using
hl_lines... ...
admonitinos: ...
and include a code example in our docs so we dont /have/ to jump links ( can literally copy paste a snippet of their markdown)
There was a problem hiding this comment.
Already make the requested changes and also leave in "Extended description
" a second version of the corrections. Regarding (can literally copy paste a snippet of their markdown) if you can guide me how, I'll do it asap. thanks!
There was a problem hiding this comment.
if you view their docs on the top right theres icons to click that edit the text
There was a problem hiding this comment.
Hi there i update al ready . Hope work ok
|
|
||
| To enhance your understanding of the documentation, here are some useful references: | ||
|
|
||
| - **mkdocs serve:** The `mkdocs serve` command is used to preview your documentation locally during the development phase. When you run this command in your terminal, MkDocs starts a development server, allowing you to view and interact with your documentation in a web browser. This is helpful for checking how your changes look before publishing the documentation. Learn more in the [mkdocs serve documentation](https://www.mkdocs.org/commands/serve/). |
There was a problem hiding this comment.
The https://www.mkdocs.org/commands/serve/ link is broken. Should it be https://www.mkdocs.org/user-guide/cli/#mkdocs-serve instead?
There was a problem hiding this comment.
Also, mkdocs serve doesn't work for me as I'm missing a lot of Python packages which are its dependencies. Here are some Python packages that need to be installed before I could run mkdocs serve:
- mkdocs
- mkdocs-material
- mkdocs-minify-plugin
- mkdocstrings
- mkdocs-rss-plugin
- mkdocs-material[imaging]
- mkdocstrings[python]
You may want to link to the https://www.mkdocs.org/user-guide/installation/ page but even that is missing almost all of the list of dependencies.
There was a problem hiding this comment.
Ah they need to pip install requirements-docs.txt
|
A few days ago I updated according to the corrections and recommendations, any other changes or we are already satisfied?thanks and good week |
|
How's it going, I hope you have a good week. After Update contributing.md #241 merged, note that I am not yet listed as a contributor. If you want me to address something of your preference, let me know. |
#239 "Documentation update proposal"
Summary by CodeRabbit
mkdocs serve.