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

Documentation improvements for v5 #2566

Open
pauldendulk opened this issue Mar 27, 2024 · 0 comments
Open

Documentation improvements for v5 #2566

pauldendulk opened this issue Mar 27, 2024 · 0 comments

Comments

@pauldendulk
Copy link
Member

This issue is to keep track of what we should improve in our documentation before the release of v5.

Things that I have in mind right now:

  • Start using the mkdocs version of our site: https://mapsui.com/v5/documentation2/
  • Update to front page of the mkdocs version to contains the most important scenarios, so that the majority of users need nothing more than that page.
  • Update the v5 upgrade guide.
  • There are a number of issues with the 'docs-need-update' tag. Go through these and update what needs to be updated.
  • The samples should be improved to function as proper documentation. More comments withing the samples. Better organization of topics, so that users can find what they are looking for when browsing through the samples.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant