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

docs: refactor markdown rendering and add switching … #1349

Merged
merged 11 commits into from
Dec 7, 2023

Conversation

HerrTopi
Copy link
Contributor

@HerrTopi HerrTopi commented Nov 4, 2023

…feature to examples

@HerrTopi HerrTopi changed the title docs(ui-color-picker): refactor markdown rendering and add switching … docs: refactor markdown rendering and add switching … Nov 4, 2023
Copy link

github-actions bot commented Nov 4, 2023

Preview URL: https://1349--preview-instui.netlify.app

docs/guides/writing-docs.md Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
Copy link
Collaborator

@matyasf matyasf left a comment

Choose a reason for hiding this comment

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

When I try to open a functional example in CodeSandbox I get and error: {"error":"Unable to process params for /define - please double check them. See https://codesandbox.io/docs/importing#create-wizard for more details."}
Also see my other comments.

docs/contributor-docs/writing-docs.md Outdated Show resolved Hide resolved
docs/contributor-docs/writing-docs.md Outdated Show resolved Hide resolved
docs/contributor-docs/writing-docs.md Outdated Show resolved Hide resolved
const { styles } = this.props
const { code, fullscreen, rtl } = this.state
const PreviewComponent = ({ themeKey, themes }: AppContextType) => (
renderPreview = (code: any, themeKey: any, themes: any) => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you please type these?

fullscreen={fullscreen}
rtl={rtl}
themeKey={themeKey}
themes={themes}
/>
</PreviewErrorBoundary>
)
}

renderTabPanel = (themeKey: any, themes: any) => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you please type these?

Copy link
Collaborator

@matyasf matyasf left a comment

Choose a reason for hiding this comment

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

There is an empty gap between the sample rendering and the edit, codesandbox etc buttons that was not there in the original, please remove it
image
Also there are 2 cases with any typing

Copy link
Contributor

@balzss balzss left a comment

Choose a reason for hiding this comment

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

do we need to display the class/function tab all the time? might be better to only show when users open the source code of the component. otherwise it looks good

Copy link
Collaborator

@matyasf matyasf 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!

@HerrTopi HerrTopi merged commit ca3b911 into master Dec 7, 2023
7 checks passed
@HerrTopi HerrTopi deleted the functionaldocs branch December 7, 2023 09:26
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