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

p4: Add & update documentation #149

Merged
merged 7 commits into from
Dec 12, 2024
Merged

Conversation

ab-gnm
Copy link
Member

@ab-gnm ab-gnm commented Dec 9, 2024

Description

Updates the README files:

  1. Adds README for chips
  2. Moves documentation for Buttons and Pager components to individual READMEs
  3. Updates android README with version catalog instructions

Testing notes/instructions:

Documentation changes only

Checklist

  • Changes have been checked by the developer
  • Changes have been checked by the reviewers
  • Unit tested

@ab-gnm ab-gnm added the Android Android specific PRs label Dec 9, 2024
Comment on lines +99 to +100
[2]: https://guardian.github.io/source-apps/android/docs/-source%20for%20-android/com.gu.source.components.chips/-source-chip.html
[3]: https://guardian.github.io/source-apps/android/docs/-source%20for%20-android/com.gu.source.components.chips/-source-chip.html
Copy link
Member Author

Choose a reason for hiding this comment

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

These links will only work after the PR has been merged into main. The documentation on GH pages is updated on merge to main.

@ab-gnm ab-gnm marked this pull request as ready for review December 9, 2024 17:20
@ab-gnm ab-gnm requested a review from a team as a code owner December 9, 2024 17:20
@ab-gnm ab-gnm changed the title Add & update documentation p4: Add & update documentation Dec 9, 2024
Copy link
Contributor

@EnochHankombo92 EnochHankombo92 left a comment

Choose a reason for hiding this comment

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

🚀

@ab-gnm ab-gnm merged commit 6a35af8 into ab/add-chips-components Dec 12, 2024
6 checks passed
@ab-gnm ab-gnm deleted the ab/add-documentation branch December 12, 2024 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Android Android specific PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants