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: |
05bceec
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5b7f816c.wiki-5tv.pages.dev |
| Branch Preview URL: | https://feat-update-contribute.wiki-5tv.pages.dev |
|
The test category should probably be left hidden for now, otherwise it'll show up in search results. |
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 |
| 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
I couldn't find a robots.txt file. Is that something server-side for the official wiki? @ozxybox |
…le with your own.
…ge and added a image.
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.Changed theReverted back as the Test Suite would appear in searches when it shouldn't._meta.jsonfile tometa.jsonunder the Testing Suite section. Not sure if that was done on purpose or not.