hackforla / hackforla/internship

TWE Design System: Create Microsite Documentation Standards and Contributor Guidelines

Open
#831 0 comments 0 reactions 1 assignee Claimed by @revforyou View on GitHub
complexity: small feature: design system role: engineering size: 1pt
Dominant language
CSS
Stars
20
Forks
6
PR merge metrics
No merged PRs in 30d

Description

### Overview
As more Design System microsites are added and updated, there is currently no documented standard for page structure, content organization, or implementation patterns.

### Action Items
- [ ] Recommended microsite page structure and section order
- [ ] Expected documentation sections (Overview, Specs, Usage, Accessibility, Code, Examples, etc.)
- [ ] Guidelines for code examples and previews
- [ ] File organization and where component assets should live
- [ ] SCSS and styling conventions
- [ ] Relationship between Figma designs and implementation
- [ ] Include necessary files in the MKdocs docs/ folder and project config
- [ ] Best practices for maintaining consistency across microsites

### Resources
- 1.01 Design Reference
- [Design Systems Figma](https://www.figma.com/file/TTRS2FWXsrymHYpPJL1IdH/Internship-Team-Main-file?type=design&node-id=2%3A45&mode=design&t=jgMN8QdoLnh9F7MT-1)
- 1.02 WIKI: [Design system microsite JavaScript](https://github.com/hackforla/internship/wiki/Design-system-microsite-javascript)
- 1.03 MKdocs folder: [/docs](https://github.com/hackforla/internship-website-design-system/tree/main/docs) on repo
- 1.04 MDdocs config file: [mkdocs.yml](https://github.com/hackforla/internship-website-design-system/blob/main/mkdocs.yml) on repo
- 1.05 variables file: [/docs/components/sass/abstracts/_variables.scss](https://github.com/hackforla/internship-website-design-system/tree/main/docs/components/sass/abstracts) on repo
- 1.06 SASS file folder: [/docs/components/sass/components](https://github.com/hackforla/internship-website-design-system/tree/main/docs/components/sass/components)
- 1.07 Variables SASS Sheet: [/docs/components/sass/abstracts/variables.sss](https://github.com/hackforla/internship-website-design-system/tree/main/docs/components/sass/abstracts/variables.scss)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.