Improved the Contribution Documentation #127
Conversation
…'s not a advanced topic and helps explain to new users how the Wiki is structured.
…s in the Test Suite
…d how to link article headers.
…h the Wiki software.
Deploying wiki with
|
| Latest commit: |
0b16a2e
|
| Status: | 🚫 Build failed. |
|
The test category should probably be left hidden for now, otherwise it'll show up in search results. |
There was a problem hiding this comment.
probably dont need to put adv- in the file name, as it'll already be prefixed with advanced
|
|
||
| This Wiki topic assumes that you understand how to work with TypeScript, SCSS, HTML, Svelte, as well as Git submodules. The Wiki software is a submodule separate from the documentation. | ||
|
|
||
| If you followed the instructions from [Getting Started](../basics/getting-started), then the Wiki software should already be setup correctly. However, if you wish to contribute to the Wiki software, you will need to make a fork of the repository so an Pull Request can be created. If you remove the current `site` folder in the `Wiki` repository and replace it with your own fork under the same name, then the Wiki will use your version of the software. |
There was a problem hiding this comment.
Rather than removing the site folder, the correct thing to do would be to repoint the git remote at the url of your fork. deleting and pasting in a new git repo may screw up the submodule
The Test Suite is programmed in the software to not show up, I believe, not base on the |
|
If you try searching for text from there it'll still appear. we'd probably also need to exclude it in the robots.txt file |
|
|
||
| # Making A New Category | ||
|
|
||
| Making a category requires that the Markdown documentation files for the category are provided. At minimum, a Markdown file and a `meta.json` file is needed to make an category work. Check out the [Category section](../basics/structure#categories) of the `Wiki Structure` article to know how to set up the `meta.json` file. |
There was a problem hiding this comment.
I would maybe merge the first two sentences. The first sentence sounds a bit off
| # Making A New Category | ||
|
|
There was a problem hiding this comment.
I would describe what these are a bit more. Maybe refer to it as a "top level category", and explain that it appears on the main page of the wiki. Took me a second to realize what this was lol
| Articles on the Strata Source Wiki consist of Markdown files that work with the [standard set of syntax](https://www.markdownguide.org/basic-syntax/). | ||
|
|
||
| The Wiki also follows some, but not all, of [GitHub's Markdown styling formats](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) (Ex. Alerts/Notices). |
There was a problem hiding this comment.
I would combine these sentences perhaps. Could also note the auto docs
Articles on the Strata Source Wiki consist of a mix of Markdown files and autogenerated docs from JSON dumps. The markdown docs follow mostly standard syntax with some of GitHub's syntax
or something vaguely similar (but maybe fancier words as you had prior)
|
|
||
| The Wiki also follows some, but not all, of [GitHub's Markdown styling formats](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) (Ex. Alerts/Notices). | ||
|
|
||
| All the Markdown files on the Wiki are inside topics. Topics are the folders that make up certain sections of categories. Example of `Category/Topic/Article`: `Audio/Overview/Sound System`. These Markdown files are placed into where they should displayed in the Wiki. |
There was a problem hiding this comment.
we dont use it much, but you can make folders nested within topics as well. such as category/topic/subtopic/subtopic2/article
Improved the contribution documentation to include some more information on how one can contribute to the Wiki, as well as instructions on getting started with the Wiki software.
Changes:
structures.mdarticle from the Advanced to the Basic topic. There is nothing really advanced about it, except for Categories, which now has its own article under advanced._meta.jsonfile tometa.jsonunder the Testing Suite section. Not sure if that was done on purpose or not.