This is the repository for the Lazerpay documentation site docs.lazerpay.finance. Lazerpay Documentation accepts contributions via GitHub pull requests. This document outlines some contributing guidelines, contact points, and other resources to make it easier to contribute to lazerpay-documentation-v2.
If you've run into a problem or have a suggestion, browse the open issues before opening a new one. We use the following label system to organize our issues.
for typos, broken links, and other quick fixes
for additions to the FAQ and Troubleshooting sections
for revisions, rewrites, and larger improvements
for feedback on structure & content
for questions that can't be answered via documentation
for improvements and fixups related to the look and feel of the docs site
-
If a question is asked more than twice in the documentation channel, it should be added as an outstanding
-
If a piece of unaddressed feedback is given more than three times, a
-
Issues will be reviewed on a rolling basis and triaged weekly by @MeisterJustice and @Frontend-io
- Create a fork of the documentation, install neccessary dependencies by running
yarn - To start your server, run
yarn devand you'll have your development server running on localhost:3000
To add a new content, e.g page, please note this is a NextJS app, a knowledge of NextJS is required to work with files and how pages are routed.
- All new pages should go to the
content/docsfolder accordingly. The pages are written in markdown (MDX - an extension of MD). - MDX allows you to use JSX components in the same file. If you have a section of the page that is written in JSX, please create that component and include it to the existing mdx-component object so it is properly mapped when rendering. Don't forget to export the component in the entry
index.tsfile before importing anywhere else. - UI Reusable components like
LzButton,LzLinkandLzContainercan be found in UI-Components. Use these components when working on any issue. You're welcome to create new UI reusable components in the same project folder. Please make sure your new resuable components follow the same naming convention as the existing components. - Tailwindcss helps you to build any design, directly in your markup. We implement this css framework in our components, so knowledge of Tailwind is required. Please go through the Typography-scss-file to understand how to apply the existing typography in our design pattern. Also, see Tailwind-config for the list of our colors, shadows, font sizes, etc. Check out Quicklinks for a sample of how these are implemented.
- Make your changes to the neccessary files, create your PR following the issue guideline
- The sidebar is quite easy to use. After creating your page, update the
sidebar.config.tsfile to include your new route/page if it's not already there. Each sidebar option has a nested structure, so if you are working on a nested link under a particular sidebar item, add that page route in theitemsarray of the sidebar config.
Contributions to lazerpay-documentation-v2 can be made via pull requests on GitHub. When opening a PR, please tag any associated parties, @MeisterJustice and @Frontend-io
Thanks to Chakra-UI team for making their Zag Docs documentation Open source and free to use.
This project follows the all-contributors specification. Contributions of any kind welcome!
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent