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

Improved Documentation Site #271

Closed
TedGoas opened this issue Nov 10, 2021 · 1 comment
Closed

Improved Documentation Site #271

TedGoas opened this issue Nov 10, 2021 · 1 comment
Labels
enhancement new or improved functionality

Comments

@TedGoas
Copy link
Collaborator

TedGoas commented Nov 10, 2021

The docs site is old and hasn't been touched in a meaningful way since 2017. Would be nice to create a multi-page section that outlines how some of this stuff works.

Code comments are helpful in the moment, but this code is not self-documenting.

Some thoughts on structure:

  1. Intro (Artwork, things to know, author, Lee's ad)
  2. The Templates (Client support, known issues)
  3. Components (Typography, lists, images, buttons, backgrounds) (bake in accessibility bits and links from resources section)
  4. Hybrid / Responsive
  5. Dark mode
  6. Contributing
@TedGoas TedGoas added the enhancement new or improved functionality label Nov 10, 2021
@TedGoas
Copy link
Collaborator Author

TedGoas commented Feb 11, 2022

Resolved in #276

@TedGoas TedGoas closed this as completed Feb 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement new or improved functionality
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@TedGoas