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.

Sign up for GitHub

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

Jump to bottom

PUPIL-439: Documentation improvements #114

Merged
merged 6 commits into from
Feb 23, 2024
Merged

PUPIL-439: Documentation improvements #114

merged 6 commits into from
Feb 23, 2024

Conversation

carlmw
Copy link
Contributor

@carlmw carlmw commented Feb 23, 2024 •
edited
Loading

  • Adds installation instructions
  • Adds documentation for using yalc
    • This could probably do with testing by someone at some point
  • Adds a bunch of type hints to the styling helpers
Screenshot 2024-02-23 at 12 48 27 Screenshot 2024-02-23 at 12 48 10
  • Embeds the repo README in Storybook as an introduction to the project
  • Moves doc blocks from stories (where appropriate) so that they will appear in Storybook and as type hints.
  • Removes the utils directory
    • This only contained the polymorphic types and its presence would make it a tempting dumping ground.
Screenshot 2024-02-23 at 12 44 44

@notion-workspace Notion Workspace
Copy link

✏️ Prepare OakComponents for use by other squads

@netlify Netlify
Copy link

netlify bot commented Feb 23, 2024 •
edited
Loading

✅ Deploy Preview for lively-meringue-8ebd43 ready!

Name Link
🔨 Latest commit 471c833
🔍 Latest deploy log https://app.netlify.com/sites/lively-meringue-8ebd43/deploys/65d89294876936000879ea9f
😎 Deploy Preview https://deploy-preview-114--lively-meringue-8ebd43.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.

@carlmw carlmw marked this pull request as ready for review February 23, 2024 12:51
@carlmw carlmw merged commit 97d8282 into main Feb 23, 2024
4 checks passed
@carlmw carlmw deleted the chore/PUPIL-439/documentation-improvements branch February 23, 2024 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benprotheroe benprotheroe benprotheroe approved these changes

@kimon-satan kimon-satan Awaiting requested review from kimon-satan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@carlmw @benprotheroe