Skip to content

Commit ffa4416

Browse files
committed
add Lektor headers and theme navigation
1 parent c7b0011 commit ffa4416

File tree

3 files changed

+30
-24
lines changed

3 files changed

+30
-24
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,43 @@
1+
_model: page
2+
---
3+
_template: page-with-toc.html
4+
---
15
title: Documentation Guidelines
6+
---
27
description: This Documentation Guidelines (style guide) ensures all the files in all repositories and any other documentation are properly documented.
3-
48
---
5-
# Documentation Guidelines
9+
body:
610

7-
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.
8-
9-
## Style Guide Reference
11+
# Documentation guidelines
1012

11-
For general writing style and guidelines, refer to the following upstream style guides:
13+
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.
1214

13-
- [Google Developer Style Guide (Preferred)](https://developers.google.com/style/)
14-
- [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/)
15+
## Style guide reference
1516

16-
## Style Preferences Modifications
17+
For general writing style and guidelines, refer to the following upstream style guides:
1718

18-
While adhering to the upstream style guides, observe the following modifications:
19-
- All acronyms must be defined on first use
20-
- Use active voice wherever possible to improve clarity and engagement.
21-
- Keep sentences concise and to the point, avoiding jargon unless necessary.
19+
- [Google Developer Style Guide (Preferred)](https://developers.google.com/style/)
20+
- [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/)
2221

22+
## Style preferences modifications
2323

24-
## Terminology
24+
While adhering to the upstream style guides, observe the following modifications:
25+
- All acronyms must be defined on first use
26+
- Use active voice wherever possible to improve clarity and engagement.
27+
- Keep sentences concise and to the point, avoiding jargon unless necessary.
2528

26-
Establishing a clear "Terminology" section for Creative Commons (CC)-specific usage is crucial. Below are some proprietary terms and their usage:
2729

28-
- **Creative Commons (CC)**: A non-profit organization enabling sharing and reuse of creative works.
29-
- **Licenses**: Legal tools that allow creators to specify how their works can be used.
30-
- **Attribution**: Giving credit to the creator of a work, required in many CC licenses.
30+
## Terminology
3131

32+
Establishing a clear "Terminology" section for Creative Commons (CC)-specific usage is crucial. Below are some proprietary terms and their usage:
3233

34+
- **Creative Commons (CC)**: A non-profit organization enabling sharing and reuse of creative works.
35+
- **Licenses**: Legal tools that allow creators to specify how their works can be used.
36+
- **Attribution**: Giving credit to the creator of a work, required by most CC licenses.
3337

34-
- ### Markdown Usage
35-
This section provides guidelines for using Markdown in documentation:
36-
- 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).
37-
- For additional information on the specific Markdown implementation used in Lektor, visit the [Lektor Markdown Documentation](https://www.getlektor.com/docs/content/#markdown).
38-
- Note: Use code block markup for instructions on installation, deployment, and development, especially to write code commands.
3938

40-
39+
## Markdown usage
40+
This section provides guidelines for using Markdown in documentation:
41+
- 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).
42+
- For additional information on the specific Markdown implementation used in Lektor, visit the [Lektor Markdown Documentation](https://www.getlektor.com/docs/content/#markdown).
43+
- Note: Use code block markup for instructions on installation, deployment, and development, especially to write code commands.

themes/vocabulary_theme/templates/layout.html

+1
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@
7979
['/contributing-code/github-repo-guidelines', 'GitHub Repo Guidelines'],
8080
['/contributing-code/repo-labels', 'Repository Labels'],
8181
['/contributing-code/foundational-tech', 'Foundational technologies'],
82+
['/contributing-code/documentation-guidelines', 'Documentation Guidelines'],
8283
['/contributing-code/javascript-guidelines', 'JavaScript Guidelines'],
8384
['/contributing-code/python-guidelines', 'Python Guidelines'],
8485
['/contributing-code/translation-guide', 'Translation Guide'],

themes/vocabulary_theme/templates/page-with-toc.html

+2
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,11 @@ <h1>{{ this.title }}</h1>
3030
{% if (href == '/contributing-code') %}
3131
<ul>
3232
{% for href, title in [
33+
['/contributing-code/foundational-tech', 'Foundational technologies'],
3334
['/contributing-code/pr-guidelines', 'Pull Request Guidelines'],
3435
['/contributing-code/github-repo-guidelines', 'GitHub Repo Guidelines'],
3536
['/contributing-code/repo-labels', 'Repository Labels'],
37+
['/contributing-code/documentation-guidelines', 'Documentation Guidelines'],
3638
['/contributing-code/javascript-guidelines', 'JavaScript Guidelines'],
3739
['/contributing-code/python-guidelines', 'Python Guidelines'],
3840
['/contributing-code/translation-guide', 'Translation Guide'],

0 commit comments

Comments
 (0)