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 landing page README #886

Closed
VGPReys opened this issue May 13, 2024 · 0 comments · Fixed by #976
Closed

Improve landing page README #886

VGPReys opened this issue May 13, 2024 · 0 comments · Fixed by #976
Assignees
Labels
documentation Improve docs

Comments

@VGPReys
Copy link
Contributor

VGPReys commented May 13, 2024

I have the feeling that the current README.md shown on the landing page of the repo is quite poor and miss some key informations such as:

  • What is the purpose of haddock
  • Where to access scenarios / examples
  • Access to the user manual
  • Access to the online code documentation
@VGPReys VGPReys added the documentation Improve docs label May 23, 2024
@rvhonorato rvhonorato linked a pull request Aug 22, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants