Closed g-elwell closed 3 months ago
Wiki was left in tact due to it being already established and linked to elsewhere. There is a note on the top directing people to the ./docs
directory. I'm less concerned about removing the wiki and more concerned about getting the README.md
up to date with correct links.
I believe that the root readme is surplus to requirements if one is contained in a /docs directory so can be removed if it's no longer needed. Might be worth deleting the wiki as well?
I think this all depends on how integration with our documentation site works. If we're able to link that to ./docs/README.md
then I think we can remove the root version.
Edit: Confirmed with @markgoodyear that our documentation will work from ./docs/README.md
and already does, so we're free to remove the root README.md
as suggested.
Thanks @ampersarnie - I think it's worth us adding that note to the top of every page in the wiki as well, as any links to sub-pages (such as the one I followed) will bypass the warning.
@g-elwell you must've clicked through to the to the Config page as it was the only one that was missing it for some reason. Anyway thats been added and I've made it more obvious using proper alerts.
@g-elwell you must've clicked through to the to the Config page as it was the only one that was missing it for some reason. Anyway thats been added and I've made it more obvious using proper alerts.
Of course I hit the only page with it missing 🤣
The readme in the root of the repo links to wiki pages, but the readme in the
/docs
directory appears to have been updated and links to other markdown files.The wiki is also outdated, the markdown files contain more information than what is available on the wiki.
I believe that the root readme is surplus to requirements if one is contained in a
/docs
directory so can be removed if it's no longer needed. Might be worth deleting the wiki as well?