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

chore: moving ordering to category jsons and frontmatters #3777

Merged
merged 2 commits into from
Dec 13, 2023

Conversation

signorecello
Copy link
Contributor

Description

This big PR does a simple thing: It makes pages ordering respect metadata instead of filenames

Problem*

A naive approach supported over the years at docusaurus was to simply have files prefixed with 00, 01, 02, which were removed automatically by docusaurus.

This makes docs a bit harder to maintain if for some reason you decide to move pages around, as it breaks all the links.

Summary*

  • Renames all the folders and pages to remove the prefixes
  • Adds sidebar_position property in frontmatter, to order them
  • Adds _category_.json files to order folders
  • Removes ordering of top level folders in sidebars.json

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 12, 2023
Copy link
Member

@TomAFrench TomAFrench left a comment

Choose a reason for hiding this comment

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

Gonna trust that all the links have been updated (does docusaurus check this automatically?)

@signorecello
Copy link
Contributor Author

@Savio-Sou my friend in PR reviews (and more) here's the PR to reorder stuff without prefixes as suggested in the docusaurus docs for v3

@signorecello
Copy link
Contributor Author

Yes @TomAFrench it will fail to build if there are dead links 👍

Copy link
Contributor

github-actions bot commented Dec 12, 2023

@signorecello signorecello added this pull request to the merge queue Dec 12, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 12, 2023
@ghost
Copy link

ghost commented Dec 12, 2023

After clicking on 'Try it now!', the following error occurs:

Uncaught (in promise) TypeError: super is not a constructor
    _j https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/1800.f7096443.js:2
    $j https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/1800.f7096443.js:2
    V_ https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/1800.f7096443.js:2
    u_ https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/1800.f7096443.js:2
    _createInstance https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/1800.f7096443.js:2
    createInstance https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/1800.f7096443.js:2
    __ https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/1800.f7096443.js:2
    ckA https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/1800.f7096443.js:2
    ckA https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/1800.f7096443.js:2
    ac https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/main.5d9bea90.js:2
    wl https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/main.5d9bea90.js:2
    kl https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/main.5d9bea90.js:2
    k https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/main.5d9bea90.js:2
    A https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/main.5d9bea90.js:2
[1800.f7096443.js:2:14780460](https://657854b8cf0a0159297cfd1b--noir-docs.netlify.app/assets/js/1800.f7096443.js)
​```

@signorecello
Copy link
Contributor Author

glad you were the only one actually clicking the preview haha I'll have a look, thanks Kev

@kevaundray
Copy link
Contributor

glad you were the only one actually clicking the preview haha I'll have a look, thanks Kev

Thats not me ser :)

@signorecello
Copy link
Contributor Author

oh damn your avatars are too similar 😄 fixed that regression @f01dab1e , somehow introduced in #3711 . Still waiting for the next docusaurus to bump webpack version, to avoid this stupid workaround

@signorecello signorecello added this pull request to the merge queue Dec 12, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 12, 2023
@signorecello signorecello added this pull request to the merge queue Dec 13, 2023
Merged via the queue into master with commit 24ff886 Dec 13, 2023
33 checks passed
@signorecello signorecello deleted the zpedro/docs_page_order branch December 13, 2023 07:23
TomAFrench added a commit that referenced this pull request Dec 14, 2023
* master: (25 commits)
  chore!: Make file manager read-only to the compiler (#3760)
  feat: Add some traits to the stdlib (#3796)
  fix: Stop issuing unused variable warnings for variables in trait definitions (#3797)
  fix(lsp): package resolution on save (#3794)
  chore: clippy fix (#3793)
  feat: Remove experimental feature warning for traits (#3783)
  fix: Allow trait method references from the trait name (#3774)
  chore: adds a new option only-acir (#3683)
  feat(lsp): add goto definition for structs (#3718)
  chore: disable code lens feature of lsp (#3789)
  chore: moving ordering to category jsons and frontmatters (#3777)
  chore(ci): use `actions/setup-node` for caching yarn dependencies (#2730)
  fix: remove `noirc_driver/aztec` feature flag in docker (#3784)
  chore: remove aztec compile time feature flag (#3596)
  chore: move debugger tests in submodule (#3780)
  feat: simplify explicit equality assertions to assert equality directly (#3708)
  fix(ssa): Handle array arguments to side effectual constrain statements (#3740)
  feat: add `prelude.nr` (#3693)
  chore: removing old docs (#3778)
  feat: avoid overflow checks on boolean multiplication (#3745)
  ...
TomAFrench added a commit that referenced this pull request Dec 14, 2023
* master: (148 commits)
  feat: add support for writing tracing debug info to file (#3790)
  chore: clippy fix (#3803)
  chore(ci): enforce timeouts on build and test workflows (#3804)
  chore!: remove unused `source-resolver` package (#3791)
  chore!: Make file manager read-only to the compiler (#3760)
  feat: Add some traits to the stdlib (#3796)
  fix: Stop issuing unused variable warnings for variables in trait definitions (#3797)
  fix(lsp): package resolution on save (#3794)
  chore: clippy fix (#3793)
  feat: Remove experimental feature warning for traits (#3783)
  fix: Allow trait method references from the trait name (#3774)
  chore: adds a new option only-acir (#3683)
  feat(lsp): add goto definition for structs (#3718)
  chore: disable code lens feature of lsp (#3789)
  chore: moving ordering to category jsons and frontmatters (#3777)
  chore(ci): use `actions/setup-node` for caching yarn dependencies (#2730)
  fix: remove `noirc_driver/aztec` feature flag in docker (#3784)
  chore: remove aztec compile time feature flag (#3596)
  chore: move debugger tests in submodule (#3780)
  feat: simplify explicit equality assertions to assert equality directly (#3708)
  ...
AztecBot pushed a commit that referenced this pull request Jan 2, 2024
sirasistant pushed a commit that referenced this pull request Jan 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants