The site is powered by docusarus and modified to meet our needs. The site is composed of pages, docs, and blogs. Pages are strictly written in HTML these include stand alone pages like our landing pages. Docs adn blogs are written in markdown and include html elements.
Docs in particular are structured in such a way where there is developer docs and design docs. For every design doc there is a developer doc. Example when you create a button.md in design/docs you also create a button.md in developer docs. They will be linked through our secondary nav as tabs design & implementation. This makes it easy to toggle between the two
Prerequisite you will need code editor of your choice we use VScode as well install yarn & node v14.17.5 you should install this using Node version manager.
- Type
nvm useif you need to install the node version typenvm install - Install modules
yarn install - When it is done
yarn startwill launch docusarus.
To contribute to the doc site you must be familiar with primarly with markdown HTML CSS and small amount of react.
- Create a new branch against
main - Name the branch something meaningful to reflect the changes you are making
- Make changes to the markdown files (do not change other files unless you are sure what you are doing)
- Preview changes by
yarn startto see the changes in realtime - Before opening a pull request
yarn buildthe entire site andyarn serveto test to see if changes work in static build - Once all is good commit and push open the pr.
- once reviewed it will be merged.
Reach out if you need any help at all.