Skip to content

Conversation

@hamishwillee
Copy link
Collaborator

@hamishwillee hamishwillee commented Dec 13, 2023

Needs new merge after:

This is a test version of PX4 user guide running on Vitepress. PX4 user guide runs on Vuepress 1 - whereas Vitepress is effectively "Vuepress 3". It has a nicer default theme, and much better build characteristics.
I'm not ready to update yet, but this project allows me to track what needs to happen for that to occur.

  • public folder in root

    • The public folder contains site stuff like logos, and also uorb graph and failsafe sim code. Needs to move from /.vuepress to root of the docs.
    • CI needs to update the build to copy files to same.
    • need to fix up pages so this renders still.
  • Package.json - make sure it matches original properly

  • .gitignore - needs to exclude build and temp files.

  • Fix The language '5' is not loaded, falling back to 'txt' for syntax highlighting. (x2)

  • index files in root and language roots

  • ::: note to :::info NOTE

  • Special cases to test/fix

    • Algolia
    • Zoom images
    • uorb graph - yes, but automated stuff happening
    • failsafe
    • tabs - caac4ff - needed plugin.
    • favicon
    • version switchers
    • Only export translated docs, not empty translations.
    • notes to info blocks conversion or just support somehow
    • Support, dev call etc where we have a page that needs to redirect - because it won't be latest.
      • Done in two items - english and also "all other langs".
      • Before merging we'd remove that PR for all other langs and let crowdin sort it out.
      • For translated pages., don't have Edit this link. Instead if possible point to crowdin
  • Convert SUMMARY.md to use -rather than *

  • Disabled checks using ignoreDeadLinks: true, in config.mjs. Need to re-enable this and fix up remaining cases for last part.

  • Convert README to index.html

    • Done for English in 8439e8a but may need to revert if doesn't rebase cleanly
    • Summary would need to be updated along with all other files.
    • Going to need to think about best way to import in crowdin.
  • Can fix up anchors <a id="reference_design_generations"></a> to be in the title ## Reference Design Generations {reference_design_generations}. Consider if needed.

  • Google analytics - needs Ramon to provide new key

  • Root redirector pages

  • Root redirect vue component

  • LinkBadge component

Other things to consider

  • Part builds for extra languages?

@@ -0,0 +1,268 @@
// .vuepress/get_sidebar.js
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Builds sidebar from readme. Need to remove some of the debug.

@hamishwillee hamishwillee force-pushed the pr_vitepress_version_test branch 4 times, most recently from 0ee3976 to 36dda97 Compare December 14, 2023 09:37
@hamishwillee hamishwillee force-pushed the pr_vitepress_version_test branch 3 times, most recently from d08503c to 4927244 Compare February 21, 2024 20:34
@hamishwillee hamishwillee force-pushed the pr_vitepress_version_test branch 2 times, most recently from 3725442 to 525b829 Compare March 28, 2024 01:23
@github-actions
Copy link

/en/contribute/support.md

  • LinkedInternalPageMissing: This linked file is missing: ../README.md

1 similar comment
@github-actions
Copy link

/en/contribute/support.md

  • LinkedInternalPageMissing: This linked file is missing: ../README.md

@hamishwillee hamishwillee force-pushed the pr_vitepress_version_test branch from 8439e8a to 685e5c6 Compare April 3, 2024 00:16
@github-actions
Copy link

github-actions bot commented Apr 3, 2024

No flaws found

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants