Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Update documentation #145

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[WIP] Update documentation #145

wants to merge 1 commit into from

Conversation

fiona-naughton
Copy link
Contributor

Overhaul of the documentation.

The main changes are:

  • Splitting up the current documentation
  • Adding additional documentation such that all files (bar some related only to linting) should be covered at least in passing
  • Adding a new "files" table that lists all all the files, a description, and an assessment on whether they are

The files table in particular may be contentious. The thought is to try make it clear to users on one hand which files are "important" or which they could theoretically remove if they prefer a slimmer package, and on the other to point out which files they'll need to edit and which they can just 'ignore'; hopefully I haven't over complicated it.

Still To Do, though these need not all happen in this PR:

  • General formatting adjustments
  • Extend the existing framework for generating the file skeleton/descriptions and use that to make the file table instead, to keep things a bit tidier?
  • Fancify the files table - allow sorting? colour coding? navigation that more closely matches an actual file tree structure?
  • Links to the MDAKits docs (inc. the example rmsf kit tutorial)
  • I've currently not added explanations for linting-associated files

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant