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

INSTUI-3890 simplify Docs build pipeline #1330

Merged
merged 3 commits into from
Oct 24, 2023
Merged

INSTUI-3890 simplify Docs build pipeline #1330

merged 3 commits into from
Oct 24, 2023

Conversation

matyasf
Copy link
Collaborator

@matyasf matyasf commented Oct 19, 2023

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

@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
@matyasf matyasf self-assigned this Oct 19, 2023
@github-actions
Copy link

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
Copy link
Collaborator Author

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

Copy link
Collaborator Author

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
Copy link
Collaborator Author

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) {
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

this was always empty

@matyasf matyasf requested review from balzss and joyenjoyer October 20, 2023 09:27
@matyasf matyasf changed the title (WIP) simplify Docs build pipeline INSTUI-3890 simplify Docs build pipeline Oct 20, 2023
Copy link
Contributor

@joyenjoyer joyenjoyer left a comment

Choose a reason for hiding this comment

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

nice work

@matyasf matyasf requested review from HerrTopi and removed request for balzss October 24, 2023 08:48
@HerrTopi HerrTopi merged commit c90c3a8 into master Oct 24, 2023
4 checks passed
@HerrTopi HerrTopi deleted the docs_build branch October 24, 2023 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants