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.

Sign up for GitHub

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

Jump to bottom

chore(docs): Bump docusaurus to 3 and update deps #2109

Merged
merged 15 commits into from
Jan 21, 2024
Merged

chore(docs): Bump docusaurus to 3 and update deps #2109

merged 15 commits into from
Jan 21, 2024

Commits on Jan 19, 2024

  1. chore(docs): Update docusaurus to 3 

    Following https://docusaurus.io/docs/migration/v3#upgrading-dependencies
and `npm update`
    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    bd1f622 View commit details
    Browse the repository at this point in the history

  2. fix(docs): Fix mdx 3 incompatibility

    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    a548383 View commit details
    Browse the repository at this point in the history

  3. fix(docs): Fix deprecated admonition types

    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    0e3ee53 View commit details
    Browse the repository at this point in the history

  4. refactor(docs): Remove no longer necessary React imports

    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    ac6ee7d View commit details
    Browse the repository at this point in the history

  5. refactor(docs): Use .mdx for docs with mdx features 

    Also applies prettier changes in touched files due to precommit
    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    a5d7ac9 View commit details
    Browse the repository at this point in the history

  6. fix(docs): Fix incorrect admonition title

    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    5e7a7be View commit details
    Browse the repository at this point in the history

  7. refactor(docs): Use new admonition title syntax and disable mdx v1 co… 

    …mpat
    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    2aa19b4 View commit details
    Browse the repository at this point in the history

  8. fix(docs): Fix relative links with trailing slashes

    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    7e90e2e View commit details
    Browse the repository at this point in the history

  9. fix(docs): Work around docusaurus bug causing broken links 

    Some links ended up broken after docusaurus 3 upgrade,
especially if they are the second on the same line and have anchors.
Likely due to facebook/docusaurus#9518
    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    b459cdd View commit details
    Browse the repository at this point in the history

  10. fix(docs): Fix broken anchors in docs (but not blog)

    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    ea8bfb2 View commit details
    Browse the repository at this point in the history

  11. ci(docs): Fix tsc config for docusaurus 3

    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    614e66b View commit details
    Browse the repository at this point in the history

  12. ci(docs): Use eslint plugin for automatic JSX runtime 

    Ref: https://docusaurus.io/docs/migration/v3#automatic-jsx-runtime
and https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/react-in-jsx-scope.md#when-not-to-use-it
    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    1ecaaee View commit details
    Browse the repository at this point in the history

  13. ci(docs): Disable eslint rule for unescaped entities 

    eslint-plugin-react is emitting a lot of react/no-unescaped-entities
errors in mdx files, primarily due to apostrophes. It seems not ideal
to have to escape every apostrophe in all mdx text, so this commit
disables the check.

There might be a better way to handle this issue, but I am not aware
of one right now.
    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    8618bf9 View commit details
    Browse the repository at this point in the history

  14. fix(docs): Fix eslint-plugin-react errors 

    Remove unused components, and disable proptype checking for children
in OsTabs custom component since I can't figure out a way to assign
propTypes to it in an mdx file.
    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    fe2f4db View commit details
    Browse the repository at this point in the history

  15. fix(docs): Fix extra line issue in hardware headers 

    Need to make prettier ignore these, because otherwise it splits
them to separate lines and reverts the whole change
    @caksoylar
    caksoylar committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    33c6a37 View commit details
    Browse the repository at this point in the history