-
-
Notifications
You must be signed in to change notification settings - Fork 173
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
Creative Common Technical Documentation Guideline page added #823
Creative Common Technical Documentation Guideline page added #823
Conversation
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.
Great start! Please see code comments
content/contributing-code/technical-docs-guidelines/contents.lr
Outdated
Show resolved
Hide resolved
content/contributing-code/technical-docs-guidelines/contents.lr
Outdated
Show resolved
Hide resolved
content/contributing-code/technical-docs-guidelines/contents.lr
Outdated
Show resolved
Hide resolved
content/contributing-code/technical-docs-guidelines/contents.lr
Outdated
Show resolved
Hide resolved
content/contributing-code/technical-docs-guidelines/contents.lr
Outdated
Show resolved
Hide resolved
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
… in templtes folder
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.
Please resolve requested changes before requesting re-review
This comment was marked as outdated.
This comment was marked as outdated.
@TimidRobot I sincerely apologize it was an oversight |
…ng code , added markdown to documentaion guideline
content/contributing-code/technical-docs-guidelines/contents.lr
Outdated
Show resolved
Hide resolved
content/contributing-code/technical-docs-guidelines/contents.lr
Outdated
Show resolved
Hide resolved
content/contributing-code/technical-docs-guidelines/contents.lr
Outdated
Show resolved
Hide resolved
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.
Nice! good work!
|
Fixes
Description
This PR introduces a set of guidelines for writing and maintaining technical documentation. It aims to create a consistent style across the open-source contributors' site by including references to upstream style guides, defining CC-specific terminology, outlining Markdown usage and syntax preferences, and recommending resources for tech-writing and Markdown.
Checklist
Update index.md
).main
ormaster
).visible errors.
Developer Certificate of Origin
For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."
Developer Certificate of Origin