Add Guide for Setting Up Local Server to Contribute to Documentation #1832
Conversation
jthiller
added
the
Solana Scribes 2024
|
Hii @jthiller would appreciate your review feedback 😊, Thanks ! |
docs/home/docs-contribution-guide.md
Outdated
There was a problem hiding this comment.
Can we rework this guide to live on https://docs.helium.com/faq/docs-installation?
local-server-guide
Outdated
There was a problem hiding this comment.
Need to remove this file.
CONTRIBUTING.md
Outdated
|
|
||
|
|
||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
Need to run prettier to clean keep consistent formatting.
docs/home/docs-contribution-guide.md
Outdated
|
|
||
| ```bash | ||
| # Clone the repository | ||
| git clone https://github.com/your-username/project-repository.git |
There was a problem hiding this comment.
this should be docs repo?
docs/home/docs-contribution-guide.md
Outdated
| git clone https://github.com/your-username/project-repository-name.git | ||
| ``` |
There was a problem hiding this comment.
this seems like a generic guide? Needs to clone docs.
There was a problem hiding this comment.
will effect the changes shortly, thanks for the feedback
There was a problem hiding this comment.
@jthiller would preciate your review feedback 😊
|
@jthiller effected all the review changed you suggested! But the installation guide link on readme.md is supposed to be the same with the new file I created , I’m guessing cos helium has its own domain hosted on GitHub pages , I can’t change that I’m using a relative link path, the official documentation uses an absolute link path so far that’s the only conflicting issue the links on that page don’t match , any guides on how I could make them make them match ? |
… as the one on contributing.md
|
@jthiller would really appreciate your review feedback |
|
Thank you for submitting updates to the Helium Docs as part of the Solana Scribes Hackathon! Please follow the instructions in this form so we may begin issuing awards. https://forms.gle/z4ovMHYDo7pzy8TN6 Please complete this form by March 15, 2024. (Approximately 1 week from today). We had SO MANY great submissions and we’re eager to distribute the awards to all of the contributors. |
|
Apologies, something happened to the Google forms link. This one should work: https://forms.gle/z4ovMHYDo7pzy8TN6 |
|
Flamingo |
Hiii, I was pretty confused initially on how to contribute to the docs since there were no guides. If it was confusing for me, it might be for someone else too (maybe future contributors), so I thought why not create this guide.
please feel free to communicate your feedback, I would gladly appreciate it , thanks !