crest icon indicating copy to clipboard operation
crest copied to clipboard

Refactor documentation

Open huwb opened this issue 2 years ago • 3 comments

This does a major pass on documentation. Moves structure from system-centric (like grouping all loddata types together) to user-centric (grouping things by category, focusing around things users want to do).

This has the high level structure in place and is ready for a high level review i'd say (but detailed notes welcome if you have them).

Docs build: https://crest.readthedocs.io/en/refactor-docs/user/quick-start-guide.html

huwb avatar Jun 07 '22 16:06 huwb

If you rename files you'll likely need to go through the C# code and update links there too.

daleeidd avatar Jun 11 '22 04:06 daleeidd

Thanks yeah there are a couple that differ between file and section header. The ones I changed were more to keep it tidy. But if you want some of them dropped lmk. If not i'll update the C# - good shout!

huwb avatar Jun 11 '22 09:06 huwb

Pheww think URLs updated although will need to do another round of testing before merge

huwb avatar Jun 11 '22 18:06 huwb