SD.Next Wiki & Docs

Wiki

Any standard SD.Next installation already includes a cloned copy of the wiki repo. Simply go to your SD.Next folder under /wiki and every article will be present as a separate markdown file (with the extension .md).

If you want to create a separate copy, SD.Next Wiki is a sub-repository of the main SD.Next GitHub repo and can be cloned by simply adding .wiki to the end of the URL:

git clone https://github.com/vladmandic/sdnext.wiki

All Wiki/Docs documents use Markdown format.

Contributing

You can edit any existing article or create a new article by editing or creating a markdown file.

GitHub does not support creation of PRs directly towards Wiki repositories

[!IMPORTANT] To avoid out-of-sync edits, always make sure you're using latest copy of wiki before performing any edits

Once you've completed edits, submit your file using whichever method is most convenient:

• Create a Discussion thread in the SD.Next GitHub repo and upload your edited markdown file
• Reach out via the Discord server - #Contribute channel

Docs

The SD.Next Documentation site is automatically built from the Wiki and does not require manual menu layout updates.

Wiki updates trigger an automatic rebuild, but no more than every 6 hours. Changes may take several hours to appear on the docs site.

The docs site is hosted in a GitHub repo that contains all necessary build scripts.

The menu layout is defined in mkdocs.yml using YAML format. Submit menu updates as a regular PR to that file.