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: added docs for ui components #1070

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

harish-viswa
Copy link
Contributor

No description provided.

Copy link

netlify bot commented Feb 10, 2025

Deploy Preview for harness-design ready!

Name Link
🔨 Latest commit da13a7a
🔍 Latest deploy log https://app.netlify.com/sites/harness-design/deploys/67ab81f92b7d360008334ead
😎 Deploy Preview https://deploy-preview-1070--harness-design.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Feb 10, 2025

Deploy Preview for harness-xd-review ready!

Name Link
🔨 Latest commit da13a7a
🔍 Latest deploy log https://app.netlify.com/sites/harness-xd-review/deploys/67ab81f9372543000858c5d1
😎 Deploy Preview https://deploy-preview-1070--harness-xd-review.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@knagurski
Copy link
Collaborator

Can we break this up into different PRs? This is too much to review without blindly rubber-stamping

Copy link
Collaborator

@knagurski knagurski left a comment

Choose a reason for hiding this comment

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

These appear to be mass-produced AI-generated docs with issues. All docs additions should be their own PRs and need to be checked over to make sure they're correct (e.g. the first component is BranchSelector, but is in a file called branch-chooser with Branch Chooser referenced etc).

@abhinavrastogi-harness
Copy link
Collaborator

agreed with the bocker here. we need to ensure correctness and basic quality. individual PRs would help with that.

however, we do need to get some basic docs ready for a majority of components, because we want to open up the component library to other teams very soon. AI can be a good way to kickstart something, but we should not be blindly committing "AI Slop".

@harish-viswa
Copy link
Contributor Author

harish-viswa commented Feb 11, 2025

These appear to be mass-produced AI-generated docs with issues. All docs additions should be their own PRs and need to be checked over to make sure they're correct (e.g. the first component is BranchSelector, but is in a file called branch-chooser with Branch Chooser referenced etc).

@knagurski Actually the file-name is Branch Chooser but the component being exported is BranchSelector, we may need to update this in BranchChooser component, and update the docs as well. Thought could take this separately

@harish-viswa
Copy link
Contributor Author

@knagurski @abhinavrastogi-harness
I was not able to mass produce the results actually, due to free tier usage 😢
I created two to three components as a group and reviewed each of them for

  1. Usage correctness
  2. Props for components and sub-components

we may have to re-look at the text content being generated which I did not give much importance to,
since it can be fine-tuned later

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