Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • D design
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 21
    • Issues 21
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 16
    • Merge requests 16
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Primer
  • design
  • Merge requests
  • !326

MVP component documentation for components A-D

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Emily Brick requested to merge component-docs-MVP-A-D into main Nov 09, 2022
  • Overview 60
  • Commits 38
  • Pipelines 0
  • Changes 16

Added components A-D for primer.style/design following the MVP component guidelines format. All new components usage docs are in the main component list on /design (EPIC).

Screen Shot 2022-12-05 at 11 05 31 AM

Notes:

  • These are brief and documented with the minimum baseline requirements of having description, usage, and visuals where applicable. The intention is that we will build on this foundation for components that need more fidelity.

  • I'm currently following the pattern of displaying the component name agnostic of how each framework might name them (for example instead of AnchoredOverlay in PascalCase (https://primer.style/react/AnchoredOverlay), it's listed as Anchored overlay in the nav and as the title of the page.

  • I'm trying to avoid linking to primer.style/react and primer.style/view-components in the documentation (it's obviously linked from the metadata, which is fine for now). The places where I may need to do that are for the Related Components sections where we only have supporting documentation in those sites.

References

  • ADR
  • Part of https://github.com/github/primer/issues/1066
  • Components E-H (PR)
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: component-docs-MVP-A-D