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

MVP-276: Component docs #54

Merged
merged 18 commits into from
Jun 5, 2024
Merged

MVP-276: Component docs #54

merged 18 commits into from
Jun 5, 2024

Conversation

BradyMitch
Copy link
Collaborator

@BradyMitch BradyMitch commented May 31, 2024

🎯 Summary

MVP-276

https://dev.developer.gov.bc.ca/docs/default/component/citz-imb-sso-css-api-npm-package/

🔰 Checklist

  • I have read and agree with the following checklist and am following the guidelines in our Code of Conduct document.
  • I have performed a self-review of my code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation where required.
  • I have tested my changes to the best of my ability.
  • I have consulted with the team if introducing a new dependency.
  • My changes generate no new warnings.

@BradyMitch BradyMitch marked this pull request as ready for review June 3, 2024 17:10
Copy link
Collaborator

@TaylorFries TaylorFries left a comment

Choose a reason for hiding this comment

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

For all the spots that have this can we consider using a note block for the "The Name column starting with * means the prop is required"
Screenshot 2024-06-05 at 8 44 53 AM

Also for these I made the note to change the phrasing on all of them but should we also make them note blocks?
Screenshot 2024-06-05 at 8 49 51 AM

mkdocs.yml Outdated Show resolved Hide resolved
BradyMitch and others added 4 commits June 5, 2024 08:57
…rs.md

Co-authored-by: TaylorFries <78506153+TaylorFries@users.noreply.github.com>
…ir-users.md

Co-authored-by: TaylorFries <78506153+TaylorFries@users.noreply.github.com>
…cgov-users.md

Co-authored-by: TaylorFries <78506153+TaylorFries@users.noreply.github.com>
…ublic-users.md

Co-authored-by: TaylorFries <78506153+TaylorFries@users.noreply.github.com>
@BradyMitch
Copy link
Collaborator Author

For all the spots that have this can we consider using a note block for the "The Name column starting with * means the prop is required" Screenshot 2024-06-05 at 8 44 53 AM

Also for these I made the note to change the phrasing on all of them but should we also make them note blocks? Screenshot 2024-06-05 at 8 49 51 AM

Yes I think you're right, I'll try that out

Copy link
Collaborator

@TaylorFries TaylorFries left a comment

Choose a reason for hiding this comment

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

🔥 🔥 🔥

@BradyMitch BradyMitch merged commit b6eed57 into main Jun 5, 2024
2 checks passed
@BradyMitch BradyMitch deleted the mvp-276-component-docs branch June 5, 2024 18:25
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.

2 participants