-
-
Notifications
You must be signed in to change notification settings - Fork 173
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add Lektor headers and theme navigation
- Loading branch information
1 parent
c7b0011
commit ffa4416
Showing
3 changed files
with
30 additions
and
24 deletions.
There are no files selected for viewing
51 changes: 27 additions & 24 deletions
51
content/contributing-code/documentation-guidelines/contents.lr
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,43 @@ | ||
_model: page | ||
--- | ||
_template: page-with-toc.html | ||
--- | ||
title: Documentation Guidelines | ||
--- | ||
description: This Documentation Guidelines (style guide) ensures all the files in all repositories and any other documentation are properly documented. | ||
|
||
--- | ||
# Documentation Guidelines | ||
body: | ||
|
||
The purpose of this guideline is to provide a step-by-step framework for writing and maintaining high-quality documentation for Creative Commons (CC) projects. This guide covers essential sections such as project style guide Preference, Style modification, terminologies, markdown usage. Following these guidelines ensures consistency, clarity, and ease of use for all contributors and users. | ||
|
||
## Style Guide Reference | ||
# Documentation guidelines | ||
|
||
For general writing style and guidelines, refer to the following upstream style guides: | ||
The purpose of this guideline is to provide a step-by-step framework for writing and maintaining high-quality documentation for Creative Commons (CC) projects. This guide covers essential sections such as project style guide Preference, Style modification, terminologies, markdown usage. Following these guidelines ensures consistency, clarity, and ease of use for all contributors and users. | ||
|
||
- [Google Developer Style Guide (Preferred)](https://developers.google.com/style/) | ||
- [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) | ||
## Style guide reference | ||
|
||
## Style Preferences Modifications | ||
For general writing style and guidelines, refer to the following upstream style guides: | ||
|
||
While adhering to the upstream style guides, observe the following modifications: | ||
- All acronyms must be defined on first use | ||
- Use active voice wherever possible to improve clarity and engagement. | ||
- Keep sentences concise and to the point, avoiding jargon unless necessary. | ||
- [Google Developer Style Guide (Preferred)](https://developers.google.com/style/) | ||
- [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) | ||
|
||
## Style preferences modifications | ||
|
||
## Terminology | ||
While adhering to the upstream style guides, observe the following modifications: | ||
- All acronyms must be defined on first use | ||
- Use active voice wherever possible to improve clarity and engagement. | ||
- Keep sentences concise and to the point, avoiding jargon unless necessary. | ||
|
||
Establishing a clear "Terminology" section for Creative Commons (CC)-specific usage is crucial. Below are some proprietary terms and their usage: | ||
|
||
- **Creative Commons (CC)**: A non-profit organization enabling sharing and reuse of creative works. | ||
- **Licenses**: Legal tools that allow creators to specify how their works can be used. | ||
- **Attribution**: Giving credit to the creator of a work, required in many CC licenses. | ||
## Terminology | ||
|
||
Establishing a clear "Terminology" section for Creative Commons (CC)-specific usage is crucial. Below are some proprietary terms and their usage: | ||
|
||
- **Creative Commons (CC)**: A non-profit organization enabling sharing and reuse of creative works. | ||
- **Licenses**: Legal tools that allow creators to specify how their works can be used. | ||
- **Attribution**: Giving credit to the creator of a work, required by most CC licenses. | ||
|
||
- ### Markdown Usage | ||
This section provides guidelines for using Markdown in documentation: | ||
- For comprehensive documentation on GitHub-flavored Markdown, refer to the [GitHub Markdown Guide](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax). | ||
- For additional information on the specific Markdown implementation used in Lektor, visit the [Lektor Markdown Documentation](https://www.getlektor.com/docs/content/#markdown). | ||
- Note: Use code block markup for instructions on installation, deployment, and development, especially to write code commands. | ||
|
||
|
||
## Markdown usage | ||
This section provides guidelines for using Markdown in documentation: | ||
- For comprehensive documentation on GitHub-flavored Markdown, refer to the [GitHub Markdown Guide](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax). | ||
- For additional information on the specific Markdown implementation used in Lektor, visit the [Lektor Markdown Documentation](https://www.getlektor.com/docs/content/#markdown). | ||
- Note: Use code block markup for instructions on installation, deployment, and development, especially to write code commands. |
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
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