Skip to content

docs: Revamp GridForm docs #3187

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
Merged
merged 55 commits into from
Nov 3, 2025
Merged

docs: Revamp GridForm docs #3187

merged 55 commits into from
Nov 3, 2025

Conversation

@aresnik11
Copy link
Contributor

@aresnik11 aresnik11 commented Oct 15, 2025 •
edited by atlassian bot
Loading

Overview

Adds new GridForm documentation for the fields available and breaks up the docs based on categories

PR Checklist

  • Related to designs:
  • Related to JIRA ticket: GMT-1455
  • I have run this code to verify it works
  • This PR includes unit tests for the code change
  • This PR includes testing instructions tests for the code change
  • The alpha package of this PR is passing end-to-end tests in all relevant Codecademy repositories

Testing Instructions

  1. Go to GridForm
  2. See the About page looks good and the links all work to the different subsections
  3. View each subsection and confirm everything looks good
  4. Finish and do a celebratory dance

PR Links and Envs

N/A docs only

Repository PR Link
Monolith Monolith PR
Mono Mono PR

aresnik11 and others added 30 commits August 11, 2025 14:03
@aresnik11
wip
53167ab
@aresnik11
Merge branch 'main' into ajr-nested-checkboxes
fff7888
@aresnik11
working
cef1cbf
@aresnik11
update types
3a53551
@aresnik11
add aria-checked
b1d05a8
@aresnik11
update stories
05c00fb
@aresnik11
fix connectednestedcheckbox
ec5e503
@aresnik11
dont use children as prop name
9562d55
@aresnik11
Merge branch 'main' into ajr-nested-checkboxes
6dbaf28
@aresnik11
add back in nested examples
f8dbe30
@aresnik11
fix errors
309c8a3
@aresnik11
PR feedback
7d5ddfa
@aresnik11
DRY up code
8f9a058
@aresnik11
first stab at tests
a34b0b5
@aresnik11
it works in gridform
641aeb2
@aresnik11
clean up logs and comments
86152dc
@aresnik11
fix defaultValue type issue
5108c8c
@aresnik11
types refactor
f67e05d
@aresnik11
gridform default value
fea9287
@aresnik11
connectedform default value
e2e3cc6
@aresnik11
update connectedform
8c65ca0
@aresnik11
add passing tests
d6b147e
@aresnik11
clean up tests
5694439
@aresnik11
Merge branch 'main' into ajr-nested-checkboxes
a562cc1
@aresnik11
PR feedback
82d2598
@aresnik11
Merge branch 'ajr-nested-checkboxes' of github.com:Codecademy/gamut i…
6208a48 
…nto ajr-nested-checkboxes
@aresnik11
Merge branch 'main' into ajr-nested-checkboxes
9a809ff
@aresnik11
improvements
b55a426
@aresnik11
Merge branch 'ajr-nested-checkboxes' of github.com:Codecademy/gamut i…
05f8fab 
…nto ajr-nested-checkboxes
@aresnik11
update gridform spacing
18bc8fd
@aresnik11 aresnik11 requested a review from a team as a code owner October 27, 2025 15:28
LinKCoding
LinKCoding reviewed Oct 28, 2025
View reviewed changes
Copy link
Contributor

@LinKCoding LinKCoding left a comment

Choose a reason for hiding this comment

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

🙏 thanks in advance — most? 99% all my feedback is related to existing issues lol

The new layout looks great! I like how it's more organized and not just one giant page :D

dreamwasp
dreamwasp reviewed Oct 29, 2025
View reviewed changes
Copy link
Contributor

@dreamwasp dreamwasp left a comment

Choose a reason for hiding this comment

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

lgtm minus the notes Kenny has

aresnik11 and others added 10 commits October 29, 2025 10:49
@aresnik11 @LinKCoding
Update packages/styleguide/src/lib/Organisms/GridForm/Fields.mdx
b491baa 
Co-authored-by: Kenny Lin <kenny.lin.91@gmail.com>
@aresnik11 @LinKCoding
Update packages/styleguide/src/lib/Organisms/GridForm/Fields.mdx
94029e1 
Co-authored-by: Kenny Lin <kenny.lin.91@gmail.com>
@aresnik11 @LinKCoding
Update packages/styleguide/src/lib/Organisms/GridForm/Fields.mdx
5aebe44 
Co-authored-by: Kenny Lin <kenny.lin.91@gmail.com>
@aresnik11 @LinKCoding
Update packages/styleguide/src/lib/Organisms/GridForm/Layout.mdx
0757139 
Co-authored-by: Kenny Lin <kenny.lin.91@gmail.com>
@aresnik11 @LinKCoding
Update packages/styleguide/src/lib/Organisms/GridForm/Fields.mdx
bddbdb3 
Co-authored-by: Kenny Lin <kenny.lin.91@gmail.com>
@aresnik11 @LinKCoding
Update packages/styleguide/src/lib/Organisms/GridForm/Validation.mdx
c22064f 
Co-authored-by: Kenny Lin <kenny.lin.91@gmail.com>
@aresnik11 @LinKCoding
Update packages/styleguide/src/lib/Organisms/GridForm/Layout.mdx
7c923dc 
Co-authored-by: Kenny Lin <kenny.lin.91@gmail.com>
@aresnik11 @LinKCoding
Update packages/styleguide/src/lib/Organisms/GridForm/States.mdx
4097e9a 
Co-authored-by: Kenny Lin <kenny.lin.91@gmail.com>
@aresnik11 @LinKCoding
Update packages/styleguide/src/lib/Organisms/GridForm/States.mdx
0506a55 
Co-authored-by: Kenny Lin <kenny.lin.91@gmail.com>
@aresnik11
PR feedback
1a1d79c
LinKCoding
LinKCoding approved these changes Oct 31, 2025
View reviewed changes
Copy link
Contributor

@LinKCoding LinKCoding left a comment

Choose a reason for hiding this comment

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

🔥 LGTM!
Just one lingering thought — but def not blocking

@codecademydev
Copy link
Collaborator

codecademydev commented Nov 3, 2025

📬 Published Alpha Packages:

@codecademy/styleguide@78.2.1-alpha.bc6f8b.0

@aresnik11 aresnik11 added the Ship It :shipit: Automerge this PR when possible label Nov 3, 2025
@codecademydev
Copy link
Collaborator

codecademydev commented Nov 3, 2025

📬 Published Alpha Packages:

@codecademy/styleguide@78.2.2-alpha.70cd93.0

@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2025

🚀 Styleguide deploy preview ready!

Preview URL: https://6908d9321ecbeea126cff625--gamut-preview.netlify.app
Deploy Logs: https://app.netlify.com/projects/gamut-preview/deploys/6908d9321ecbeea126cff625

@aresnik11 aresnik11 added Ship It :shipit: Automerge this PR when possible and removed Ship It :shipit: Automerge this PR when possible labels Nov 3, 2025
@codecademydev codecademydev merged commit 6877b8c into main Nov 3, 2025
17 of 19 checks passed
@codecademydev codecademydev removed the Ship It :shipit: Automerge this PR when possible label Nov 3, 2025
@codecademydev codecademydev deleted the ajr-gridform-sb-docs branch November 3, 2025 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@LinKCoding LinKCoding LinKCoding approved these changes

@dreamwasp dreamwasp dreamwasp approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@aresnik11 @codecademydev @LinKCoding @dreamwasp