Creative Common Technical Documentation Guideline page added

Dev-JoyA commented 1 month ago

Fixes

Fixes #792 by @briandominick

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

[x] My pull request has a descriptive title (not a vague title like Update index.md).
[x] My pull request targets the default branch of the repository (main or master).
[x] My commit messages follow best practices.
[x] My code follows the established code style of the repository.
[ ] I added or updated tests for the changes I made (if applicable).
[x] I added or updated documentation (if applicable).
[x] I tried running the project locally and verified that there are no 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

``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```

TimidRobot commented 1 month ago

@Dev-JoyA please also fix the markdown syntax in the Description ([ x] and [x ] should be [x])

Dev-JoyA commented 1 month ago

@Dev-JoyA please also fix the markdown syntax in the Description ([ x] and [x ] should be [x])

Noted

Dev-JoyA commented 1 month ago

@Dev-JoyA please also fix the markdown syntax in the Description ([ x] and [x ] should be [x])

@TimidRobot Resolved

Dev-JoyA commented 1 month ago

Please resolve requested changes before requesting re-review

@TimidRobot I sincerely apologize it was an oversight

Dev-JoyA commented 1 month ago

Nice! good work! @TimidRobot Thank you so much , and I am so sorry for stressing you on this PR

creativecommons / creativecommons.github.io-source