geddski / geddski/csstyle

autodoc

Open
#21 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
CSS
Stars
840
Forks
29
PR merge metrics
No merged PRs in 30d

Description

One cool thing would be to be able to autodoc all components. This doc would show every component and option available along with html samples and the results. Since you already define components with functions it would remove a lot of boilerplate from https://github.com/kneath/kss. WDYT?

Contributor guide

Open the contributing guide

Research direction

Review how components are currently defined as functions and compare the requested output with the linked kss project. Determine the scope for documenting every component, option, HTML sample, and rendered result; done would require an agreed design and a complete generated documentation approach.

Written by the indexing model from the issue text.

Assessment

Tech stack
css
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.