-
Notifications
You must be signed in to change notification settings - Fork 101
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
INSTUI-3890 simplify Docs build pipeline #1330
Conversation
@tsProps was used when the codebase was mixed JS and TS, now its not nededed since its pure TS
refresh react-dogen types remove unused jsdoc parser code
Preview URL: https://1330--preview-instui.netlify.app |
@@ -85,77 +92,61 @@ type JSDocFunctionReturns = { | |||
names: string[] | |||
} | |||
} | |||
// TODO remove these types, now we can get them directly from react-docgen | |||
// TODO these are from React-docgen Documentation.d.ts, | |||
// remove when react-docgen exports them |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've opened a ticket for them reactjs/react-docgen#864
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this code is just a refresh (copypaste) of their type definitions
@@ -55,18 +56,6 @@ export function getJSDoc(source: Buffer, error: (err: Error) => void) { | |||
} | |||
doc = { | |||
...module, | |||
sections: sections |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this part was never used by the docs
@@ -368,31 +361,6 @@ import { ${importName} } from '${esPath}' | |||
) | |||
} | |||
|
|||
let sections | |||
|
|||
if (doc.sections) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this was always empty
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice work
Make typings better, remove some dead code.
TEST PLAN:
Compare the docs pages (especially the props part) with the current prod one and check if nothing is missing/changed