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

Add documentation to README.md in all packages #202

Closed
24 of 25 tasks
sebnitu opened this issue Jun 14, 2020 · 19 comments
Closed
24 of 25 tasks

Add documentation to README.md in all packages #202

sebnitu opened this issue Jun 14, 2020 · 19 comments
Labels
IS: docs

Comments

@sebnitu
Copy link
Owner

sebnitu commented Jun 14, 2020 •
edited

Problem

Not all packages have fully documented README.md files.

Solution

We should add documentation in all package and component README.md files. This should be closely paralleled with the web documentation and cover things like:

  • Installation
    • Styles
    • JavaScript
    • Markup
      • component__element
      • data-attr
      • Notes
  • Modifiers
    • component_modifier
      • component_modifier_key
  • Customization
    • Sass Variables
    • JavaScript Options
  • Events
  • API
    • api.method()

Starter Template

Documentation Status

Here's a checklist to track which components have their README.md documentation added.

  • Base
  • Breadcrumb
  • Button
  • Button-group
  • Card
  • Checkbox
  • Core
  • Dialog
  • Drawer
  • Grid
  • Icon
  • Icon-action
  • Input
  • Level
  • Media
  • Menu
  • Modal
  • Notice
  • Popover
  • Radio
  • Section
  • Switch
  • Table
  • Utility
  • Vrembem
@sebnitu
Copy link
Owner Author

sebnitu commented Jul 25, 2020

#265 Adds README docs to @vrembem/base

@sebnitu
Copy link
Owner Author

sebnitu commented Aug 17, 2020 •
edited

#320 Adds README docs to @vrembem/checkbox

@sebnitu
Copy link
Owner Author

sebnitu commented Aug 27, 2020

#355 Adds README docs to @vrembem/media

@sebnitu
Copy link
Owner Author

sebnitu commented Aug 28, 2020

#362 Adds README docs to @vrembem/button-group

@sebnitu
Copy link
Owner Author

sebnitu commented Sep 5, 2020

#377 Adds README docs to @vrembem/notice

@sebnitu
Copy link
Owner Author

sebnitu commented Oct 23, 2020

#434 Adds README docs to @vrembem/section

@sebnitu
Copy link
Owner Author

sebnitu commented Mar 14, 2021

#521 Adds README docs to @vrembem/icon

@sebnitu
Copy link
Owner Author

sebnitu commented Apr 6, 2021

#544 Adds README docs to @vrembem/button

@sebnitu
Copy link
Owner Author

sebnitu commented Apr 17, 2021

#551 Adds README docs to @vrembem/breadcrumb

@sebnitu
Copy link
Owner Author

sebnitu commented Apr 25, 2021

#555 Adds README docs to @vrembem/radio

@sebnitu
Copy link
Owner Author

sebnitu commented Apr 26, 2021

#556 Adds README docs to @vrembem/switch

@sebnitu
Copy link
Owner Author

sebnitu commented May 4, 2021

#572 Adds README docs to @vrembem/card

@sebnitu
Copy link
Owner Author

sebnitu commented May 5, 2021

#573 Adds README docs to @vrembem/dialog

@sebnitu
Copy link
Owner Author

sebnitu commented May 6, 2021

#574 Adds README docs to @vrembem/icon-action

@sebnitu
Copy link
Owner Author

sebnitu commented May 10, 2021

#575 Adds README docs to @vrembem/table

@sebnitu
Copy link
Owner Author

sebnitu commented May 26, 2021

#580 Adds README docs to @vrembem/input

@sebnitu
Copy link
Owner Author

sebnitu commented Jun 1, 2021

#607 Adds README docs to @vrembem/menu

@sebnitu
Copy link
Owner Author

sebnitu commented Jun 26, 2021

#614 Adds README docs to @vrembem/popover

@sebnitu
Copy link
Owner Author

sebnitu commented Sep 1, 2023

This list is now outdated and next branch will require a lot of documentation rewrites.

@sebnitu sebnitu closed this as completed Sep 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
IS: docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sebnitu