SD.Next Wiki & Docs
Wiki
Any standard SD.Next installation already includes cloned copy of wiki repo, simply go to you SD.Next folder under /wiki
and every article will be present as a separte markdown file (with the extension .md
)
If you want to create separate copy, SD.Next Wiki is a sub-repository to 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
Standard format for all Wiki/Docs documents is Markdown
Contributing
You can edit any existing article by editing its markdown file or create a new article by creating a new markdown file
[!NOTE] 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 the edits, you can submit your file using whatever is simplest to you:
- Create a Discussion thread in SD.Next GitHub repo and upload your edited MD file
- Reach out via Discord server - #Contribute channel
Docs
SD.Next Documentation site is automatically built from Wiki and does not need to be manually updated with extension of the menu layout
Any updates to Wiki will trigger automatic rebuild, but not more frequent than every 6 hours - thus any Wiki updates may take several hours to be displayed in docs site
Docs site is hosted in GitHub repo Which contains all the necessary scripts
Menu layout is defined in menu using YAML format and any updates should be submited as a regular PR to that file