Skip to content

docs: add additional information to the documentation#431

Merged
danielroe merged 9 commits into
nuxt-modules:mainfrom
Jamiewarb:docs/information-expansion
Jul 27, 2023
Merged

docs: add additional information to the documentation#431
danielroe merged 9 commits into
nuxt-modules:mainfrom
Jamiewarb:docs/information-expansion

Conversation

@Jamiewarb

@Jamiewarb Jamiewarb commented Jul 26, 2023

Copy link
Copy Markdown
Contributor

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.

image

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: false in Installation and in "Watchouts" section

@ghost

ghost commented Jul 26, 2023

Copy link
Copy Markdown

Live Preview ready!

Name Edit Preview Latest Commit
Ionic Edit on Studio ↗︎ View Live Preview 8429f57

@netlify

netlify Bot commented Jul 26, 2023

Copy link
Copy Markdown

Deploy Preview for friendly-lamington-fb5690 canceled.

Name Link
🔨 Latest commit 8429f57
🔍 Latest deploy log https://app.netlify.com/sites/friendly-lamington-fb5690/deploys/64c274bdc3af5400083268f2

Comment thread docs/content/1.get-started/5.watch-outs.md Outdated
Comment thread docs/content/3.cookbook/3.app-tabs.md Outdated
@codecov-commenter

codecov-commenter commented Jul 27, 2023

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 83.36%. Comparing base (481b4de) to head (8429f57).
Report is 277 commits behind head on main.

Files with missing lines Patch % Lines
src/module.ts 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            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     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@danielroe danielroe left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

@danielroe danielroe merged commit 2d40e84 into nuxt-modules:main Jul 27, 2023
@Jamiewarb

Copy link
Copy Markdown
Contributor Author

🎉

@Jamiewarb Jamiewarb deleted the docs/information-expansion branch July 27, 2023 18:50
@github-actions github-actions Bot mentioned this pull request Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

3 participants