issues
search
R2Northstar
/
NorthstarDocs
Guides and tutorials on how to use and mod Northstar
https://docs.northstar.tf/
MIT License
0
stars
8
forks
source link
Transfer from ModdingDocs
#1
Open
GeckoEidechse
opened
2 months ago
GeckoEidechse
commented
2 months ago
TODOs
[x] Import ModdingDocs git history
[x] Adjust folder structure for new docs and change all text file endings from
.rst
to
.md
[x] Add files required for mkdocs to run
[x] Adjust Poetry project
[x] Fix up re-write
[x] Overwrite all files with those from re-rewrite -> #2
[x] Add main page -> #3
[x] Other minor fixes
[x] Verify everything looks fine
[ ] Import most currently open
[ ] PRs
[x] Issues
[ ] Import last remaining open
[ ] PRs
[ ] Issues
[x] Update links everywhere to point to new docs
[x] Wiki ->
https://github.com/R2Northstar/NorthstarWiki/pull/309
[x] Website ->
https://github.com/R2Northstar/NorthstarTF/pull/105
[x] Discord FAQ
[x] Add deprecation notice to old modding docs ->
https://github.com/R2Northstar/ModdingDocs/pull/255
[x] GitHub readme
[x] in the docs as a header or something using e.g.
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-rst_prolog
[ ] Archive old modding docs
Post transfer
[x] Add link checker from Wiki repo -> #6
[ ] Add workflow to build in strict mode for PRs to catch any build warnings
[x] Make sure that all mentions of
squirrel_re
are
squirrel_re
and not
rsquirrel
or the like -> #13
[ ]
Update contributing page with info from
refactoring.md
[ ] Deal with duplicate statements page breaking new docs page
[x] Investigate integrating wiki -> #62
TODOs
.rst
to.md
Post transfer
squirrel_re
aresquirrel_re
and notrsquirrel
or the like -> #13Update contributing page with info fromrefactoring.md