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

improve documentation for new users #18

Open
lars2015 opened this issue Jul 17, 2023 · 4 comments
Open

improve documentation for new users #18

lars2015 opened this issue Jul 17, 2023 · 4 comments
Assignees
Labels
enhancement New feature or request

Comments

@lars2015
Copy link
Contributor

Is your feature request related to a problem?

  • new users need more detailed documentation to get started with MPTRAC

Describe the solution you'd like

  • check/revise the README file
  • revise and extend the mkdocs manual, including descriptions of individual apps/tools
  • add/check links to references and other sources of information
  • revise and extend the doxygen manual

Additional ideas

  • implement `-help' flags in the apps
  • create and add small logo for MPTRAC on doxygen and mkdocs manual
@lars2015 lars2015 added the enhancement New feature or request label Jul 17, 2023
@lars2015 lars2015 self-assigned this Jul 17, 2023
@lars2015 lars2015 changed the title improve the documentation improve documentation for new users Jul 17, 2023
@hydrogencl
Copy link
Collaborator

Here I want to provide the solution to fix the documentation.
I change the path in the session of deploying_doxygen

from
publish_dir: ./docs/docs
to
publish_dir: ./docs/docs/html

since doxygen will generate the files in docs/docs/html

@lars2015
Copy link
Contributor Author

  • We need to update the documentation of the trac tool.

@fkhosrawi
Copy link
Collaborator

We also need to implement the comments and corrections from Jonas into the new version of the documentation and to improve the documentation of the control parameters, there are many missing in the doxygen list.

@lars2015
Copy link
Contributor Author

lars2015 commented Oct 3, 2024

Found some references and tools to improve documentation:

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

No branches or pull requests

3 participants