docs: add additional information to the documentation #431
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Live Preview ready!
|
✅ Deploy Preview for friendly-lamington-fb5690 canceled.
|
…a page on-top of app tabs
danielroe
reviewed
Jul 27, 2023
danielroe
reviewed
Jul 27, 2023
Codecov Report
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. @@ Coverage Diff @@
## main #431 +/- ##
==========================================
+ Coverage 82.96% 83.36% +0.40%
==========================================
Files 9 9
Lines 493 493
Branches 30 30
==========================================
+ Hits 409 411 +2
+ Misses 84 82 -2
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Co-authored-by: Daniel Roe <[email protected]>
Co-authored-by: Daniel Roe <[email protected]>
|
🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds additional information to the documentation. It aims to expand on what was already there, adding further information, examples, and links, as well as provide new information and best practices for developing with Nuxt and Ionic.
It provides an architecture for categorising pages and for adding more later, covering "Get Started", "Overview" and "Cookbook".
Getting Started covers users who are looking to get to grips with the project in their application. It covers a module intro, installation, configuration, setting up Capacitor, and watch outs for those new to Ionic.
Overview goes more into the detail of what the module is doing under the hood, and has some information on how to use some of its features. It covers Routing, Theming, Auto-imports, Module components/utilities, Icons and Deployment.
Cookbook is an example-heavy section for common use cases. It can include things outside of the scope of the module, but that users will find helpful as they use this module.
Most sections link out to vue, nuxt, ionic or capacitor documentation, allowing the user to further expand their knowledge on these sections if they wish, or it links to relevant pages within the modules own documentation.
Happy to make any and all changes as required, and hope that it's the beginning of helping clean up some of the questions people have been having.
#6 - I've added a cookbook page for this, though we should look to refine it further and make sure we're completely happy
#42 - Can possibly close this, as it's covered by the Introduction section? Let me know if you think further info should be added to cover this
#121 - This issue and workaround is now mentioned in the Watchouts section
Closes #56 - This is now covered in the "Deploying" section, and links out to the Ionic docs
Closes #231 - This is thoroughly covered in the "Routing" section of the docs
Closes #197 - This is now covered in the "Routing" section and "Watchouts" section
Closes #425 - This is covered in docs through several mentions of
ssr: falsein Installation and in "Watchouts" section