Update index.md with better documentation #9037
Open
+85
−30
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
UDDITwork
requested review from
Pwuts and
Bentlybro
and removed request for
a team
|
|
|
This PR targets the Automatically setting the base branch to |
github-actions
bot
added
documentation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
✅ Deploy Preview for auto-gpt-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for auto-gpt-docs-dev ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Do you think we should link to material for mkdocs |
|
Hi Nicholas,
Thank you for the suggestion regarding linking material for MkDocs. I’m
open to exploring this further but would appreciate a bit more clarity. Are
you suggesting adding a specific resource or guide that contributors can
reference? Let me know your thoughts so I can align accordingly.
Best regards,
UDDIT
www.udditportfolio.online +91-7456886877
Follow me on :Twitter <https://x.com/UdditRise> Youtube
***@***.***> Linkedin
<https://www.linkedin.com/in/uddit-7258792ab/> Blogs
<https://www.udditportfolio.online/blog> Research Gate
<https://www.researchgate.net/profile/Uddit>
…On Tue, 17 Dec 2024 at 11:50 PM, Nicholas Tindle ***@***.***> wrote:
Do you think we should link to material for mkdocs
—
Reply to this email directly, view it on GitHub
<#9037 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BIELEY4ZZJKHN6UMJVDFXCD2GBTP3AVCNFSM6AAAAABTYPHTXKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNBZGI2TQMRQGU>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
|
We use material for mkdocs for a lot of the features like code snippets, annotations, link handling, and much more. It may be useful to call that resource out so people know to look there first for un recognized markdown or things they're trying to do. What do you think? Here's a link to it |
ntindle
requested changes
Dec 17, 2024
docs/content/contribute/index.md
Outdated
Comment on lines
7
to
9
|  | ||
|  | ||
|  |
There was a problem hiding this comment.
I like the idea process behind this but lets remove them for now since they don't work in the preview build (https://deploy-preview-9037--auto-gpt-docs-dev.netlify.app/contribute/)
|
|
||
| or | ||
| - Git installed on your machine | ||
| - Python 3.8 or higher |
There was a problem hiding this comment.
we should probably require a more modern version of python based on what the platform needs but that's a later problem I think
Comment on lines
+38
to
+40
| ```shell | ||
| mkdocs serve | ||
| ``` |
There was a problem hiding this comment.
You can also pass -a localhost:8392 to run it on a different port so it doesn't conflict with supabase when running the full stack
docs/content/contribute/index.md
Outdated
Comment on lines
52
to
53
| - Navigate to `docs/content` | ||
| - Create a new markdown file |
There was a problem hiding this comment.
I think you need one more space here for this to render correctly
docs/content/contribute/index.md
Outdated
Comment on lines
71
to
73
| mkdocs build | ||
| ``` | ||
| Watch for any warnings about broken links in the console output! 🚨 |
There was a problem hiding this comment.
Really good call out here!!!! dead links are bad!
docs/content/contribute/index.md
Outdated
Comment on lines
79
to
92
| 1. **Create a Branch** 🌿 | ||
| - Use a descriptive name for your branch | ||
| - Keep changes focused and atomic | ||
|
|
||
| 2. **Submit PR** 📮 | ||
| - Fill out the PR template | ||
| - Add screenshots if applicable | ||
| - Link related issues | ||
|
|
||
| 3. **Review Process** 👥 | ||
| - Address reviewer feedback | ||
| - Make requested changes | ||
| - Maintain active communication | ||
|
|
There was a problem hiding this comment.
same as above -- need an additonal space
docs/content/contribute/index.md
Outdated
Comment on lines
105
to
107
| **Thank you for contributing to our documentation!** ❤️ | ||
|
|
||
| *Together, we make documentation better for everyone.* |
There was a problem hiding this comment.
I'm not sure why this isn't bolded correctly
|
www.udditportfolio.online +91-7456886877
Follow me on :Twitter <https://x.com/UdditRise> Youtube
***@***.***> Linkedin
<https://www.linkedin.com/in/uddit-7258792ab/> Blogs
<https://www.udditportfolio.online/blog> Research Gate
<https://www.researchgate.net/profile/Uddit>
…On Wed, 18 Dec 2024 at 3:51 AM, Nicholas Tindle ***@***.***> wrote:
***@***.**** requested changes on this pull request.
------------------------------
In docs/content/contribute/index.md
<#9037 (comment)>
:
> +
+
+
I like the idea process behind this but lets remove them for now since
they don't work in the preview build (
https://deploy-preview-9037--auto-gpt-docs-dev.netlify.app/contribute/)
[image: Uploading image.png…]
------------------------------
In docs/content/contribute/index.md
<#9037 (comment)>
:
>
- or
+- Git installed on your machine
+- Python 3.8 or higher
we should probably require a more modern version of python based on what
the platform needs but that's a later problem I think
------------------------------
In docs/content/contribute/index.md
<#9037 (comment)>
:
> + ```shell
+ mkdocs serve
+ ```
You can also pass -a localhost:8392 to run it on a different port so it
doesn't conflict with supabase when running the full stack
------------------------------
In docs/content/contribute/index.md
<#9037 (comment)>
:
> + - Navigate to `docs/content`
+ - Create a new markdown file
I think you need one more space here for this to render correctly
image.png (view on web)
<https://github.com/user-attachments/assets/78fa7725-fefd-4739-815f-e60d6f1e6520>
------------------------------
In docs/content/contribute/index.md
<#9037 (comment)>
:
> +mkdocs build
+```
+Watch for any warnings about broken links in the console output! 🚨
Really good call out here!!!! dead links are bad!
------------------------------
In docs/content/contribute/index.md
<#9037 (comment)>
:
> +1. **Create a Branch** 🌿
+ - Use a descriptive name for your branch
+ - Keep changes focused and atomic
+
+2. **Submit PR** 📮
+ - Fill out the PR template
+ - Add screenshots if applicable
+ - Link related issues
+
+3. **Review Process** 👥
+ - Address reviewer feedback
+ - Make requested changes
+ - Maintain active communication
+
same as above -- need an additonal space
image.png (view on web)
<https://github.com/user-attachments/assets/1038cbe5-9ccf-47dc-9361-1fd92e384d0a>
------------------------------
In docs/content/contribute/index.md
<#9037 (comment)>
:
> +**Thank you for contributing to our documentation!** ❤️
+
+*Together, we make documentation better for everyone.*
I'm not sure why this isn't bolded correctly
image.png (view on web)
<https://github.com/user-attachments/assets/fb59826a-2e0c-416b-9788-78765e8cf2f5>
—
Reply to this email directly, view it on GitHub
<#9037 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BIELEYYKLOZHHW6DBMLJAET2GCPWBAVCNFSM6AAAAABTYPHTXKVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDKMJQGI3DENJQGY>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes 🏗️
Checklist 📋
For code changes:
Example test plan
For configuration changes:
.env.exampleis updated or already compatible with my changesdocker-compose.ymlis updated or already compatible with my changesExamples of configuration changes