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

[Experimental]: Frontload docs support #20

Merged
merged 21 commits into from
Mar 17, 2022
Merged

Conversation

sserrata
Copy link
Member

Description

Attempt to add support for front loading MD/MDX docs before API docs. It is intended to work as follows:

  • Define beforeApiDocs plugin option as array of relative paths to MD/MDX docs to frontload
  • MD/MDX docs read in a processed, i.e. proper doc metadata is added
  • MD/MDX docs are processed through createData and generateSidebar

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes if appropriate.
  • All new and existing tests passed.

@sserrata
Copy link
Member Author

Currently having issues with getting versionMetadata right.

@github-actions
Copy link

github-actions bot commented Mar 14, 2022

Size Change: +24.7 kB (+1%)

Total Size: 3.97 MB

Filename Size Change
demo/build/assets/js/17896441.********.js 12.6 kB +107 B (+1%)
demo/build/assets/js/4c5e977b.********.js 35.9 kB +446 B (+1%)
demo/build/assets/js/9616.********.js 0 B -2.23 MB (removed) 🏆
demo/build/assets/js/9a562316.********.js 1.06 kB +149 B (+16%) ⚠️
demo/build/assets/js/b5257597.********.js 4.17 kB +235 B (+6%) 🔍
demo/build/assets/js/main.********.js 407 kB +2.02 kB (0%)
demo/build/assets/js/runtime~main.********.js 8.2 kB +248 B (+3%)
demo/build/assets/js/42c07454.********.js 5.85 kB +5.85 kB (new file) 🆕
demo/build/assets/js/466dcb64.********.js 3.54 kB +3.54 kB (new file) 🆕
demo/build/assets/js/52d34678.********.js 3.02 kB +3.02 kB (new file) 🆕
demo/build/assets/js/7017.********.js 2.23 MB +2.23 MB (new file) 🆕
demo/build/assets/js/9f85b634.********.js 3.55 kB +3.55 kB (new file) 🆕
demo/build/assets/js/c76c11f6.********.js 3.03 kB +3.03 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
demo/.docusaurus/globalData.json 2.22 kB 0 B
demo/build/assets/css/styles.********.css 90.3 kB +6 B (0%)
demo/build/assets/js/010b0d5d.********.js 7.31 kB 0 B
demo/build/assets/js/021c2319.********.js 19.6 kB 0 B
demo/build/assets/js/09ead32c.********.js 16.8 kB 0 B
demo/build/assets/js/0c270917.********.js 7.59 kB 0 B
demo/build/assets/js/0cb18c9d.********.js 17.7 kB 0 B
demo/build/assets/js/0e384e19.********.js 4.56 kB 0 B
demo/build/assets/js/1181d397.********.js 12.5 kB 0 B
demo/build/assets/js/16abef02.********.js 12.6 kB 0 B
demo/build/assets/js/18c41134.********.js 16.9 kB 0 B
demo/build/assets/js/1bbda95d.********.js 26 kB 0 B
demo/build/assets/js/1be78505.********.js 11.1 kB 0 B
demo/build/assets/js/1e4232ab.********.js 5.62 kB 0 B
demo/build/assets/js/1f391b9e.********.js 2.62 kB 0 B
demo/build/assets/js/22648341.********.js 3.44 kB 0 B
demo/build/assets/js/25013e4a.********.js 10.7 kB 0 B
demo/build/assets/js/26fa5e84.********.js 3.45 kB 0 B
demo/build/assets/js/2c32bac3.********.js 7.66 kB 0 B
demo/build/assets/js/2d2458d1.********.js 19.6 kB 0 B
demo/build/assets/js/2ee8962c.********.js 7.43 kB 0 B
demo/build/assets/js/31d12231.********.js 7.54 kB 0 B
demo/build/assets/js/3373.********.js 12.2 kB 0 B
demo/build/assets/js/341550c5.********.js 11.5 kB 0 B
demo/build/assets/js/3914806c.********.js 10.8 kB 0 B
demo/build/assets/js/393be207.********.js 3.08 kB 0 B
demo/build/assets/js/428b4c57.********.js 18.3 kB 0 B
demo/build/assets/js/4eeb3c5d.********.js 10.5 kB 0 B
demo/build/assets/js/51e890c3.********.js 15.7 kB 0 B
demo/build/assets/js/52c4b3e2.********.js 12.6 kB 0 B
demo/build/assets/js/533a09ca.********.js 4.96 kB 0 B
demo/build/assets/js/5388d76b.********.js 20.3 kB 0 B
demo/build/assets/js/54843f7d.********.js 11.7 kB 0 B
demo/build/assets/js/5aa5a9cd.********.js 8.89 kB 0 B
demo/build/assets/js/5c868d36.********.js 5.69 kB 0 B
demo/build/assets/js/60b38b8e.********.js 7.35 kB 0 B
demo/build/assets/js/60e13cef.********.js 16.8 kB 0 B
demo/build/assets/js/6119.********.js 1.02 kB 0 B
demo/build/assets/js/6533f3d7.********.js 13 kB 0 B
demo/build/assets/js/69ba2909.********.js 11.5 kB 0 B
demo/build/assets/js/6a7cf16d.********.js 19.3 kB 0 B
demo/build/assets/js/6ce157fc.********.js 11.7 kB 0 B
demo/build/assets/js/6ed40b15.********.js 7.65 kB 0 B
demo/build/assets/js/72390392.********.js 12.5 kB 0 B
demo/build/assets/js/79147915.********.js 17.7 kB 0 B
demo/build/assets/js/7a5457fa.********.js 14.1 kB 0 B
demo/build/assets/js/7cc518f2.********.js 8.8 kB 0 B
demo/build/assets/js/822bd8ab.********.js 5.36 kB 0 B
demo/build/assets/js/8826c0db.********.js 16.4 kB 0 B
demo/build/assets/js/8e36997c.********.js 19.3 kB 0 B
demo/build/assets/js/8e44c742.********.js 17.7 kB 0 B
demo/build/assets/js/935f2afb.********.js 3.54 kB 0 B
demo/build/assets/js/94214df4.********.js 19.8 kB 0 B
demo/build/assets/js/98463c12.********.js 10.5 kB 0 B
demo/build/assets/js/a172e59e.********.js 17.3 kB 0 B
demo/build/assets/js/a30588cf.********.js 14.1 kB 0 B
demo/build/assets/js/a356afa7.********.js 17.3 kB 0 B
demo/build/assets/js/a5c48ae3.********.js 13 kB 0 B
demo/build/assets/js/a6966617.********.js 16.8 kB 0 B
demo/build/assets/js/ac3cc3f5.********.js 10.9 kB 0 B
demo/build/assets/js/af70375d.********.js 15.7 kB 0 B
demo/build/assets/js/b5efbc84.********.js 7.35 kB 0 B
demo/build/assets/js/b68d1b59.********.js 18.3 kB 0 B
demo/build/assets/js/b9572ad5.********.js 7.59 kB 0 B
demo/build/assets/js/ba5ac426.********.js 12.1 kB 0 B
demo/build/assets/js/bac076bc.********.js 20.3 kB 0 B
demo/build/assets/js/bde5d56a.********.js 18.1 kB 0 B
demo/build/assets/js/be3e95ec.********.js 11.5 kB 0 B
demo/build/assets/js/c4403e14.********.js 10.7 kB 0 B
demo/build/assets/js/c4f5d8e4.********.js 72.3 kB 0 B
demo/build/assets/js/c87b34e1.********.js 18.1 kB 0 B
demo/build/assets/js/d01652cd.********.js 19.8 kB 0 B
demo/build/assets/js/d38d1999.********.js 10.6 kB 0 B
demo/build/assets/js/d6cb8c6d.********.js 7.57 kB 0 B
demo/build/assets/js/dd1a1797.********.js 16.4 kB 0 B
demo/build/assets/js/dd2855f3.********.js 12.1 kB 0 B
demo/build/assets/js/dff1c289.********.js 6.37 kB 0 B
demo/build/assets/js/e44a2883.********.js 7.62 kB 0 B
demo/build/assets/js/e4da18c0.********.js 16.8 kB 0 B
demo/build/assets/js/e91d46ba.********.js 7.59 kB 0 B
demo/build/assets/js/ee030bdf.********.js 7.48 kB 0 B
demo/build/assets/js/f13f1da7.********.js 26 kB 0 B
demo/build/assets/js/f55d3e7a.********.js 5.18 kB 0 B
demo/build/assets/js/f6149237.********.js 11.6 kB 0 B
demo/build/assets/js/fd1ce97f.********.js 7.48 kB 0 B
demo/build/assets/js/fefa319c.********.js 17.8 kB 0 B
demo/build/index.html 72.6 kB +10 B (0%)

compressed-size-action

@github-actions
Copy link

github-actions bot commented Mar 14, 2022

Visit the preview URL for this PR (updated for commit b23f10f):

https://docusaurus-openapi-36b86--pr20-d9wjg5eq.web.app

(expires Fri, 15 Apr 2022 22:33:01 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@sserrata sserrata added enhancement New feature or request and removed DO NOT MERGE labels Mar 16, 2022
Copy link
Collaborator

@blindaa121 blindaa121 left a comment

Choose a reason for hiding this comment

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

Looks good, frontloaded docs work like a charm! 🚀

@sserrata sserrata merged commit dfbe6db into panw-main Mar 17, 2022
@sserrata sserrata deleted the frontload-docs-support branch May 23, 2022 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants