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

Organize autogenerated docs into categories #3704

Merged
merged 1 commit into from May 15, 2023
Merged

Conversation

cmdcolin
Copy link
Collaborator

This organizes the autogenerated docs into categories based on roughly what type of element each thing is

It also puts the autogenerated docs as top level categories instead of being inside the config guides/developer guides sections (also moves url query param api to top level category)

It also reverts #3671 because this didn't work with our <Figure/> component in the docs

@github-actions github-actions bot added the needs label triage Needs a label to show in changelog (breaking, enhancement, bug, documentation, or internal) label May 12, 2023
@cmdcolin cmdcolin force-pushed the autogen_organization branch 2 times, most recently from 95dd692 to 6fd5bf3 Compare May 12, 2023 10:41
@cmdcolin cmdcolin added documentation and removed needs label triage Needs a label to show in changelog (breaking, enhancement, bug, documentation, or internal) labels May 12, 2023
@codecov
Copy link

codecov bot commented May 12, 2023

Codecov Report

Merging #3704 (da4ec34) into main (edc067f) will decrease coverage by 0.01%.
The diff coverage is 58.33%.

❗ Current head da4ec34 differs from pull request most recent head 02cc8aa. Consider uploading reports for the commit 02cc8aa to get more accurate results

@@            Coverage Diff             @@
##             main    #3704      +/-   ##
==========================================
- Coverage   64.22%   64.21%   -0.01%     
==========================================
  Files         924      924              
  Lines       29920    29918       -2     
  Branches     7256     7252       -4     
==========================================
- Hits        19216    19213       -3     
- Misses      10523    10524       +1     
  Partials      181      181              
Impacted Files Coverage Δ
...kages/core/assemblyManager/assemblyConfigSchema.ts 90.00% <ø> (ø)
.../pluggableElementTypes/models/BaseDisplayModel.tsx 80.43% <ø> (ø)
...ore/pluggableElementTypes/models/BaseTrackModel.ts 31.70% <ø> (ø)
...core/pluggableElementTypes/models/BaseViewModel.ts 64.28% <ø> (ø)
...uggableElementTypes/models/InternetAccountModel.ts 73.56% <ø> (ø)
...leElementTypes/models/baseInternetAccountConfig.ts 50.00% <ø> (ø)
packages/core/ui/SnackbarModel.ts 66.66% <ø> (ø)
packages/product-core/src/RootModel/Base.ts 32.00% <ø> (ø)
...ges/product-core/src/RootModel/InternetAccounts.ts 90.24% <ø> (ø)
...lugins/alignments/src/LinearPileupDisplay/model.ts 71.96% <ø> (ø)
... and 78 more

... and 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@cmdcolin cmdcolin force-pushed the autogen_organization branch 5 times, most recently from 2d5bf0c to 657c504 Compare May 15, 2023 14:59
Organization of autogen docs

Misc

Back to stable docusaurus, the figures were messed up with the canaryg

Increase timeout to avoid possibly flakiness xref https://github.com/GMOD/jbrowse-components/actions/runs/4957826756/jobs/8869965294

Misc

Add autogenerated to combined docs
@cmdcolin cmdcolin merged commit ed471df into main May 15, 2023
11 of 12 checks passed
@cmdcolin cmdcolin deleted the autogen_organization branch May 15, 2023 17:23
cmdcolin added a commit that referenced this pull request May 18, 2023
New autogen organization

Organization of autogen docs

Misc

Back to stable docusaurus, the figures were messed up with the canaryg

Increase timeout to avoid possibly flakiness xref https://github.com/GMOD/jbrowse-components/actions/runs/4957826756/jobs/8869965294

Misc

Add autogenerated to combined docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant