This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
fix(api): fixed api generation issues and improved transformer #2758
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ovflowd
added
enhancement
5 tasks
|
This is still making multiple large changes at once. I've opened #2759 with a clean version update |
ovflowd
force-pushed
the
feat/api-transformer-fixes
branch
from
e3a0299
to
2e3476f
Compare
|
Correcting my previous comment, I think I got what you meant all along, by having a separate PR that just updates the current docs, we can have the least possible diff. |
ovflowd
force-pushed
the
feat/api-transformer-fixes
branch
2 times, most recently
from
08c0179
to
9c18409
Compare
nschonni
reviewed
Sep 12, 2022
Codecov Report
@@ Coverage Diff @@
## main #2758 +/- ##
==========================================
- Coverage 66.02% 62.87% -3.16%
==========================================
Files 118 123 +5
Lines 1351 1441 +90
Branches 342 361 +19
==========================================
+ Hits 892 906 +14
- Misses 422 494 +72
- Partials 37 41 +4
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
nschonni
reviewed
Sep 12, 2022
ovflowd
force-pushed
the
feat/api-transformer-fixes
branch
from
9c18409
to
52bc63e
Compare
ovflowd
commented
Sep 12, 2022
|
@nschonni I'm updating this PR and decoupling the visual changes on Markdown-side. So that we have a grasp of the actual diff. |
|
@nschonni @benhalverson PR ready for review, the verbose now is way smaller and the actual changes are visible. |
refactor(api): improved api generation and reduced noise chore(docs): resynced docs fix(structure-types): improved recognition for structure types chore(api): synced api docs
feat(utils): created util specific for data tags replacement chore(components): updated usage of components for data-tag replacement and improved toc chore(snaps): updated snapshots chore(api): regenerated api docs
ovflowd
force-pushed
the
feat/api-transformer-fixes
branch
from
5ca1451
to
428c616
Compare
benhalverson
approved these changes
Sep 13, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR tackles the remaining MDX/Markdown issues from our repository. Basically the current
sync-apiscript still had some issues and some of our Markdown pages are non-conforming, son this PR does the following:sync-apiand its API utilities fixing the existing problems such as:<https://....>links to be transformed into markdown links, and inline{}syntax to be escaped)<DataTag>from TableOfContents and ApiLinks by decoupling the logic from the actual componentsgatsby-plugin-mdxwhich should reduce the amount ofbabel generator warningsdue to large size markdown filesCheck List
npm run lint:js -- --fixand/ornpm run lint:md -- --fixfor my JavaScript and/or Markdown changes.npm run testto check if all tests are passing, and/ornpm run test -- -uto update snapshots if I created and/or updated React Components.npm run buildwork fine.