Skip to content

Commit

Permalink
Fixed docs references for: Major reworking of the documentation (#1051)
Browse files Browse the repository at this point in the history
* Fixed: Completed updating references to folder docs to docs/docs

* Restored new line
  • Loading branch information
ronzulu authored Sep 6, 2024
1 parent e1c4db7 commit 72e7535
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
4 changes: 2 additions & 2 deletions docs/docs/en/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Please note that:
The documentation consists of Markdown files which [MkDocs](https://www.mkdocs.org/) converts to static web pages.
Specifically, this project uses [MkDocs Material](https://squidfunk.github.io/mkdocs-material/getting-started/).

These files reside in `docs/` in the respective language's folder. For instance, English docs are located in `docs/en/`.
These files reside in `docs/docs/` in the respective language's folder. For instance, English docs are located in `docs/docs/en/`.
The docs are served on [https://www.stephenmwangi.com/obsidian-spaced-repetition/](https://www.stephenmwangi.com/obsidian-spaced-repetition/).
Expand All @@ -142,7 +142,7 @@ For larger diffs, it's important that you check how your docs look like as expla

### Translating Documentation

1. Create a folder for your language in `docs/` if it doesn't exist. Use the language codes provided [here](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language).
1. Create a folder for your language in `docs/docs/` if it doesn't exist. Use the language codes provided [here](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language).
2. Add the code from (1) to the MkDocs configuration (`mkdocs.yml` - `plugins.i18n.languages`).
3. Copy the files from the English (`en`) folder into the new folder.
4. Translate then open a pull request.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/zh/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Please note that:
The documentation consists of Markdown files which [MkDocs](https://www.mkdocs.org/) converts to static web pages.
Specifically, this project uses [MkDocs Material](https://squidfunk.github.io/mkdocs-material/getting-started/).

These files reside in `docs/` in the respective language's folder. For instance, English docs are located in `docs/en/`.
These files reside in `docs/docs/` in the respective language's folder. For instance, English docs are located in `docs/docs/en/`.
The docs are served on [https://www.stephenmwangi.com/obsidian-spaced-repetition/](https://www.stephenmwangi.com/obsidian-spaced-repetition/).
Expand All @@ -121,7 +121,7 @@ For larger diffs, it's important that you check how your docs look like as expla

### Translating Documentation

1. Create a folder for your language in `docs/` if it doesn't exist. Use the language codes provided [here](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language).
1. Create a folder for your language in `docs/docs/` if it doesn't exist. Use the language codes provided [here](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language).
2. Add the code from (1) to the MkDocs configuration (`mkdocs.yml` - `plugins.i18n.languages`).
3. Copy the files from the English (`en`) folder into the new folder.
4. Translate then open a pull request.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"format": "npx prettier --write .",
"lint": "npx prettier --check . && npx eslint src/",
"test": "jest",
"changelog": "auto-changelog --template=compact --package && npx prettier --write docs/changelog.md",
"changelog": "auto-changelog --template=compact --package && npx prettier --write docs/docs/changelog.md",
"e2e": "make setup_e2e && wdio run ./wdio.conf.js"
},
"keywords": [
Expand Down

0 comments on commit 72e7535

Please sign in to comment.