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.

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

Documentation #33

Open
1 of 18 tasks
jacobxperez opened this issue Nov 1, 2023 · 0 comments
Open
1 of 18 tasks

Documentation #33

jacobxperez opened this issue Nov 1, 2023 · 0 comments
Assignees
Labels
documentation Issue relataed to documentation help wanted Help is needed for this issue

Comments

@jacobxperez
Copy link
Owner

jacobxperez commented Nov 1, 2023

Updating the docs

To update the documentation, install all dependencies on your machine and run the command npm run docs. You can find the source files for the documentation under the "src/docs" folder. After updating the documentation, run npm run rams to update the root folder docs. This will automatically update the website on a pull request.

Documentation checklist

We need to add documentation highlighting each one of Rams features:

  • Layout
    • Container
    • Grid System
    • Flex Box
    • Breakpoints
  • Navigation
    • Anchor
    • Breadcrumb
    • Tabs
    • Navbar
  • Dropdown
    • Menu
    • Tooltip
    • Accordion
  • Buttons
  • Icons
  • JavaScript
    • data-attributes manipulation
@jacobxperez jacobxperez added help wanted Help is needed for this issue documentation Issue relataed to documentation labels Nov 1, 2023
@jacobxperez jacobxperez self-assigned this Nov 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue relataed to documentation help wanted Help is needed for this issue
Projects
None yet
Development

No branches or pull requests

1 participant