-
Notifications
You must be signed in to change notification settings - Fork 88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[GH-1105] - WIP - Documentation style guide revision #1196
Conversation
Hello @matthew-src, Thanks for your pull request! A Core Committer will review your pull request soon. For code contributions, you can learn more about the review process here. |
This is awesome, Matthew! The handbook doesn't have a preview build so we just merge and iterate as needed. This looks great to me - let me know if you want to merge to see the changes or if you work locally and are using local builds to track. |
Thank you @justinegeffen. I am still working on this, so please wait to merge. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, @matthew-src!
Hi @justinegeffen and @cwarnermm, I made a few more edits to the guide, and added the new pages for RST and MD to the SUMMARY.md page. I hope this means that they will appear in the navigation bar of the Gitbook. Feel free to merge this now to see the changes. |
@matthew-src, I'm so sorry - I merged this before reviewing it thoroughly and noticed some changes that I wanted to query so I've reverted the changes which means they need to be redone. I'm going to redo them on my side as I messed up. I did have some questions about the content that was removed but will raise them in the new PR. Sorry about this; I know this wasn't a quick one to put together. |
No problem! |
In terms of an ETA, I'll aim to get this redone by Friday. Thanks for understanding! :) |
Summary
This PR is for revisions to the Documentation style guide in the technical writing section of the handbook. It is a WIP, any feedback is welcome. So far this PR:
This is related to #1105.