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

docs: Rewrite and restructure the documentation website #933

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

aklinker1
Copy link
Collaborator

@aklinker1 aklinker1 commented Aug 20, 2024

@aklinker1 aklinker1 self-assigned this Aug 20, 2024
@aklinker1 aklinker1 added the docs Improvements or additions to documentation label Aug 20, 2024
Copy link

netlify bot commented Aug 20, 2024

Deploy Preview for creative-fairy-df92c4 failed.

Name Link
🔨 Latest commit e68d951
🔍 Latest deploy log https://app.netlify.com/sites/creative-fairy-df92c4/deploys/66e5f51f4bfb860008d14a12

Comment on lines 38 to 103
# https://github.com/wxt-dev/wxt/issues/704
# Generated via `find docs/.vitepress/dist -type f -name "*.html"`
/guide/i18n/build-integrations.html /TODO
/guide/i18n/introduction.html /TODO
/guide/i18n/messages-file-format.html /TODO
/guide/i18n/editor-support.html /TODO
/guide/i18n/installation.html /TODO
/guide/key-concepts/content-script-ui.html /TODO
/guide/key-concepts/manifest.html /TODO
/guide/key-concepts/wxt-submit.html /TODO
/guide/key-concepts/auto-imports.html /TODO
/guide/key-concepts/web-extension-polyfill.html /TODO
/guide/key-concepts/frontend-frameworks.html /TODO
/guide/key-concepts/multiple-browsers.html /TODO
/guide/go-further/entrypoint-loaders.html /TODO
/guide/go-further/es-modules.html /TODO
/guide/go-further/handling-updates.html /TODO
/guide/go-further/custom-events.html /TODO
/guide/go-further/debugging.html /TODO
/guide/go-further/remote-code.html /TODO
/guide/go-further/vite.html /TODO
/guide/go-further/testing.html /TODO
/guide/go-further/how-wxt-works.html /TODO
/guide/go-further/reusable-modules.html /TODO
/guide/extension-apis/messaging.html /TODO
/guide/extension-apis/i18n.html /TODO
/guide/extension-apis/storage.html /TODO
/guide/extension-apis/scripting.html /TODO
/guide/extension-apis/others.html /TODO
/guide/upgrade-guide/wxt.html /TODO
/guide/directory-structure/components.html /TODO
/guide/directory-structure/hooks.html /TODO
/guide/directory-structure/assets.html /TODO
/guide/directory-structure/package.html /TODO
/guide/directory-structure/env.html /TODO
/guide/directory-structure/wxt-config.html /TODO
/guide/directory-structure/wxt.html /TODO
/guide/directory-structure/public/locales.html /TODO
/guide/directory-structure/public/index.html /TODO
/guide/directory-structure/entrypoints/devtools.html /TODO
/guide/directory-structure/entrypoints/sidepanel.html /TODO
/guide/directory-structure/entrypoints/content-scripts.html /TODO
/guide/directory-structure/entrypoints/newtab.html /TODO
/guide/directory-structure/entrypoints/bookmarks.html /TODO
/guide/directory-structure/entrypoints/unlisted-pages.html /TODO
/guide/directory-structure/entrypoints/unlisted-scripts.html /TODO
/guide/directory-structure/entrypoints/options.html /TODO
/guide/directory-structure/entrypoints/background.html /TODO
/guide/directory-structure/entrypoints/popup.html /TODO
/guide/directory-structure/entrypoints/history.html /TODO
/guide/directory-structure/entrypoints/sandbox.html /TODO
/guide/directory-structure/entrypoints/css.html /TODO
/guide/directory-structure/web-ext-config.html /TODO
/guide/directory-structure/tsconfig.html /TODO
/guide/directory-structure/utils.html /TODO
/guide/directory-structure/app-config.html /TODO
/guide/directory-structure/composables.html /TODO
/guide/directory-structure/output.html /TODO
/get-started/assets.html /TODO
/get-started/introduction.html /TODO
/get-started/configuration.html /TODO
/get-started/publishing.html /TODO
/get-started/migrate-to-wxt.html /TODO
/get-started/compare.html /TODO
/get-started/entrypoints.html /TODO
/get-started/installation.html /TODO
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

TODO

Copy link

codecov bot commented Aug 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.78%. Comparing base (45809c0) to head (b1d4859).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #933      +/-   ##
==========================================
- Coverage   82.14%   81.78%   -0.37%     
==========================================
  Files         125      125              
  Lines        6593     6593              
  Branches     1099     1096       -3     
==========================================
- Hits         5416     5392      -24     
- Misses       1163     1187      +24     
  Partials       14       14              

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

@aklinker1 aklinker1 changed the title Add placeholder redirects for all pages that are changing docs: Restructure Aug 20, 2024
navItem('Examples', '/examples'),
navItem('API', '/api/reference/wxt'),
navItem('---', [
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

TODO

@aklinker1 aklinker1 changed the title docs: Restructure docs: Rewrite and restructure all docs Aug 20, 2024
@aklinker1 aklinker1 changed the title docs: Rewrite and restructure all docs docs: Rewrite and restructure the documentation website Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

Doc Structure Improvements
2 participants