-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated template,structure and complete refactor
- Loading branch information
1 parent
ce791fc
commit eb98806
Showing
518 changed files
with
100,541 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
APPLICATION_ID= | ||
API_KEY= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
build | ||
node_modules | ||
*.cjs | ||
|
||
sidebars-*.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
{ | ||
"env": { | ||
"browser": true, | ||
"es2021": true | ||
}, | ||
"settings": { | ||
"react": { | ||
"version": "detect" | ||
} | ||
}, | ||
"extends": ["eslint:recommended", "plugin:react/recommended"], | ||
"parserOptions": { | ||
"ecmaFeatures": { | ||
"jsx": true | ||
}, | ||
"ecmaVersion": "latest", | ||
"sourceType": "module" | ||
}, | ||
"plugins": ["react"], | ||
"rules": { | ||
"react/prop-types": "off", | ||
"no-unused-vars": "warn" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Dependencies | ||
/node_modules | ||
|
||
# Production | ||
/build | ||
.env | ||
|
||
# Generated files | ||
.docusaurus | ||
.cache-loader | ||
|
||
# Misc | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
#!/bin/sh | ||
. "$(dirname "$0")/_/husky.sh" | ||
|
||
npx --no-install commitlint --edit "" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
#!/bin/sh | ||
. "$(dirname "$0")/_/husky.sh" | ||
|
||
npm run lint:fix |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
#!/bin/sh | ||
. "$(dirname "$0")/_/husky.sh" | ||
|
||
exec < /dev/tty && npx git-cz --hook || true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# autogenerated files | ||
docs/*ui-kit/reference/**/*.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
const mainConfig = { | ||
branches: ['main'], | ||
plugins: [ | ||
'@semantic-release/commit-analyzer', | ||
'@semantic-release/release-notes-generator', | ||
'@semantic-release/changelog', | ||
[ | ||
'@semantic-release/npm', | ||
{ | ||
npmPublish: false, | ||
tarballDir: 'dist' | ||
} | ||
], | ||
[ | ||
'@semantic-release/git', | ||
{ | ||
assets: [ | ||
'package.json', | ||
'package-lock.json', | ||
'CHANGELOG.md' | ||
], | ||
message: 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}\n\n\nskip-checks: true' | ||
} | ||
], | ||
[ | ||
'@semantic-release/github', | ||
{ | ||
assets: 'dist/*.tgz' | ||
} | ||
] | ||
], | ||
repositoryUrl: 'https://github.com/dyte-in/docs' | ||
}; | ||
|
||
module.exports = mainConfig; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"emmet.includeLanguages": { | ||
"mdx": "javascriptreact" | ||
} | ||
} |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Code of Conduct | ||
|
||
All Dyte repos are governed by our Community Participation Guidelines, available at: https://dyte.notion.site/dyte/Dyte-Community-Participation-Guidelines-CPG-4b3af58fdf3545c2a3065773a9154728 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
# Contributing | ||
|
||
Thanks for contributing! :smile: | ||
We love contributions from everyone. | ||
By participating in this project, | ||
you agree to abide by our [code of conduct](./CODE_OF_CONDUCT.md). | ||
|
||
The following is a set of guidelines for contributing. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. | ||
|
||
## Table of Contents | ||
|
||
1. [Styleguides](#styleguides) | ||
2. [What should I know before I get started?](#what-should-i-know-before-i-get-started) | ||
3. [How Can I contribute?](#how-can-i-contribute) | ||
4. [Code Contribution](#code-contribution) | ||
|
||
# Guidelines | ||
|
||
The following are the guidelines we request you to follow in order to contribute to this project. | ||
|
||
## Styleguides | ||
|
||
### Commit Messages | ||
|
||
The commit messages should follow the following pattern: | ||
|
||
```bash | ||
feat: Description # if a new feature is added | ||
fix: Description # if a bug is fixed | ||
refactor: Description # if code is refactored | ||
docs: Description # if documentation is added | ||
lint: Description # if a lint issue is fixed | ||
``` | ||
|
||
### Issues | ||
|
||
```bash | ||
update: Description # if an update is required for a feature | ||
bug: Description # if there is a bug in a particular feature | ||
suggestion: Description # if you want to suggest a better way to implement a feature | ||
``` | ||
|
||
### Code Styleguide | ||
|
||
The code should satisfy the following: | ||
|
||
- Have meaningful variable names, either in `snake_case` or `camelCase`. | ||
- Have no `lint` issues. | ||
- Have meaningful file names, directory names and directory structure. | ||
- Have a scope for easy fixing, refactoring and scaling. | ||
|
||
## What should I know before I get started | ||
|
||
You can contribute to any of the features you want, here's what you need to know: | ||
|
||
- How the project works. | ||
- The technology stack used for the project. | ||
- A brief idea about writing documentation. | ||
|
||
## How Can I Contribute | ||
|
||
You can contribute by: | ||
|
||
- Reporting Bugs | ||
- Suggesting Enhancements | ||
- Code Contribution | ||
- Pull Requests | ||
|
||
## Code Contribution | ||
|
||
1. Checkout the latest `main` branch to make sure the feature hasn't been implemented or the bug hasn't been fixed yet. | ||
2. Check the issue tracker to make sure someone already hasn't requested it and/or contributed to it. | ||
3. Fork it! | ||
4. Create your feature branch: `git checkout -b feature/my-new-feature` | ||
5. Add your changes: `git add .` | ||
6. Commit your changes: `git commit -am 'feat: Add some feature'` | ||
7. Push to the branch: `git push -u origin feature/my-new-feature` | ||
8. Submit a pull request :sunglasses: | ||
|
||
### Pull Requests | ||
|
||
Make sure to document the contributions well in the pull request. | ||
Pull requests should have: | ||
|
||
- A concise commit message. | ||
- A description of what was changed/added. | ||
|
||
Others will give constructive feedback. | ||
This is a time for discussion and improvements, | ||
and making the necessary changes will be required before we can | ||
merge the contribution. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,181 @@ | ||
<!-- PROJECT LOGO --> | ||
<p align="center"> | ||
<a href="https://dyte.io"> | ||
<img src="https://assets.dyte.io/logo-outlined.png" alt="Logo" width="120"> | ||
</a> | ||
|
||
<h2 align="center">Dyte Docs</h3> | ||
|
||
<p align="center"> | ||
Dyte's documentation portal, built with Docusaurus. | ||
<br /> | ||
<a href="https://docs.dyte.io"><strong>Explore the docs »</strong></a> | ||
<br /> | ||
<br /> | ||
<a href="https://app.dyte.io">View Demo</a> | ||
· | ||
<a href="https://github.com/dyte-in/docs/issues">Report Bug</a> | ||
· | ||
<a href="https://github.com/dyte-in/docs/issues">Request Feature</a> | ||
</p> | ||
</p> | ||
|
||
<!-- TABLE OF CONTENTS --> | ||
|
||
## Table of Contents | ||
|
||
- [About the Project](#about-the-project) | ||
- [Built With](#built-with) | ||
- [Getting Started](#getting-started) | ||
- [Prerequisites](#prerequisites) | ||
- [Installation](#installation) | ||
- [Usage](#usage) | ||
- [Version History](#version-history) | ||
- [Roadmap](#roadmap) | ||
- [Contributing](#contributing) | ||
- [Support](#support) | ||
- [License](#license) | ||
- [About](#about) | ||
|
||
<!-- ABOUT THE PROJECT --> | ||
|
||
## About The Project | ||
|
||
[Docusaurus](https://docusaurus.io/) is a static site generator that helps you ship beautiful, accessible docs. For building our [documentation](https://docs.dyte.io) portal, we have made certain modifications over the template generated by [Docusaurus](https://docusaurus.io) to be able to properly showcase all our SDKs with their respective versions. | ||
|
||
We are delighted to see our documentation featured on [Docusaurus Site Showcase](https://docusaurus.io/showcase), and hope you like it! | ||
|
||
### Built With | ||
|
||
- [Docusaurus](https://docusaurus.io/) | ||
- [React](https://reactjs.org/) | ||
- [Tailwind](https://tailwindcss.com/) | ||
|
||
<!-- GETTING STARTED --> | ||
|
||
## Getting Started | ||
|
||
This section describes how you can get our documentation portal up and running on your machine. | ||
|
||
### Prerequisites | ||
|
||
- [node](https://nodejs.org/en/) | ||
- [npm](https://www.npmjs.com/) | ||
|
||
### Installation | ||
|
||
1. Clone the repo | ||
|
||
```sh | ||
git clone https://github.com/dyte-in/docs.git | ||
``` | ||
|
||
2. Install NPM packages | ||
|
||
```sh | ||
npm install | ||
``` | ||
|
||
3. Run the app | ||
|
||
```sh | ||
npm start | ||
``` | ||
|
||
<!-- USAGE EXAMPLES --> | ||
|
||
## Usage | ||
|
||
<!-- In usage, mention how to edit the docs, how to update versions, etc. --> | ||
|
||
### Writing Documentation | ||
|
||
To just edit older documentation, go to the specified versioned folder for a section, for example, you want to edit documentation for React SDK v0.25.x, open up [react_versioned_docs/version-0.25.x](./react_versioned_docs/version-0.25.x) and edit the required files there. | ||
|
||
To create a new version inside a section, for example, flutter. Make your changes in [docs/flutter](./docs/flutter). The `./docs` folder consists of the `next` version, which is unpublished, and is where you add your newer or _next_ version of documentation. | ||
|
||
After your changes are done, to create a version, run the following command: | ||
|
||
```sh | ||
npm run docusaurus docs:version:flutter 1.2.3 | ||
``` | ||
|
||
This will create a new version `1.2.3` for flutter. | ||
|
||
Reference: https://docusaurus.io/docs/versioning | ||
|
||
### To add new sections | ||
|
||
Create a new section in docusaurus by adding a new plugin entry in [docusaurus.config.js](./docusaurus.config.js). | ||
|
||
If you're adding a new section, just add new section to `SECTIONS[]` array with the `defineSection()` utility easily. | ||
|
||
Now, run `npm start` and you can access your Go docs at http://localhost:3000/go/introduction | ||
|
||
Then, you can create versions and edit older versions as mentioned above. | ||
|
||
### Adding new docs to the Context Switcher | ||
|
||
To add a newly created section to the Sections Menu, edit [./src/sections.js](src/sections.js). | ||
|
||
For example, for a section go, you will add: | ||
|
||
```jsx | ||
import { GoIcon } from '../assets/icons'; | ||
|
||
const SECTIONS = [ | ||
// ... | ||
{ | ||
id: 'go', | ||
name: 'Go', | ||
icon: GoIcon, | ||
section: false, // if it shouldn't have a sections menu | ||
}, | ||
] | ||
``` | ||
|
||
You'll need to create a GoIcon component too. | ||
|
||
That is it! | ||
|
||
<!-- CHANGELOG --> | ||
|
||
## Version History | ||
|
||
See [CHANGELOG](./CHANGELOG.md). | ||
|
||
<!-- ROADMAP --> | ||
|
||
## Roadmap | ||
|
||
See the [open issues](https://github.com/dyte-in/docs/issues) for a list of proposed features (and known issues). | ||
|
||
<!-- CONTRIBUTING --> | ||
|
||
## Contributing | ||
|
||
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Sincere thanks to all our contributors. Thank you, [contributors](https://github.com/dyte-in/docs/graphs/contributors)! | ||
|
||
You are requested to follow the contribution guidelines specified in [CONTRIBUTING.md](./CONTRIBUTING.md) and code of conduct at [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) while contributing to the project :smile:. | ||
|
||
## Support | ||
|
||
Contributions, issues, and feature requests are welcome! | ||
Give a ⭐️ if you like this project! | ||
|
||
<!-- LICENSE --> | ||
|
||
## License | ||
|
||
Distributed under the Apache License, Version 2.0. See [`LICENSE`](./LICENSE) for more information. | ||
|
||
<!-- MARKDOWN LINKS & IMAGES --> | ||
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
|
||
## About | ||
|
||
`docs` is created & maintained by Dyte, Inc. You can find us on Twitter - [@dyte_io](https://twitter.com/dyte_io) or write to us at `dev [at] dyte.io`. | ||
|
||
The names and logos for Dyte are trademarks of Dyte, Inc. | ||
|
||
We love open source software! See [our other projects](https://github.com/dyte-in) and [our products](https://dyte.io). |
Oops, something went wrong.