Genesis platform documentation

Documentation is written using Markdown format.

Contribution

Now our community team is accepting contributions from all community members of Genesis. All accepted contributions will be published on our official website.

Please check our Contribution guide on Notion.

If you are willing to contribute, please follow the links below:

• Internal contributor if you are an internal contributor currently working at Genesis.
• External contributor if you are an external contributor not currently working at Genesis.

Stack Overflow

We have a Stack Overflow community. If you have a Genesis Login, take a look. Or, click here to get a new genesis login. We are encouraging our teams, customers and contributors to participate in this community.

Installation

npm i

Local development

npm run start

This command starts a local development server and opens a browser window. Most changes are reflected live without having to restart the server.

Build

To generate the static files for deployment, you can run the build as below.

For a complete build, execute npm run build:

npm run build

If you prefer to run a local build only, we recommend using npm run build-main:

npm run build-main

Both commands generate static content into the build directory.

Preview

To run a local development server for previewing and testing your Docusaurus site during development, you can run the command below

npm run serve

Clear

npm run clear

This command clears the Docusaurus generated assets, caches, build artefacts etc. This is useful if you're not seeing your changes in the browser.

Copy FE docs

Front-end documentation from foundation-ui can be pulled into this repo. This process has been automated - see scripts/README.md for details.

Automated Process (Recommended)

# Basic sync (no git operations)
npm run sync-api-docs

# Full automation (with git operations)
npm run sync-api-docs:full

Basic sync automatically:

1. Checks for the latest version of @genesislcap packages
2. Updates package.json with new versions
3. Installs dependencies with npm install
4. Builds the api-docs plugin
5. Copies documentation without starting the server
6. Updates processedMap with new versions

Full automation does everything above plus: 7. Creates a git branch 8. Commits changes 9. Pushes the branch 10. Provides instructions for creating a pull request

Manual Process (Legacy)

If you need to run the process manually, follow these steps:

1. Add as a dependency in ./package.json.
2. Set up the config in ./plugins/api-docs/manifest.json.
3. Set up the sidebar.
4. Run with $ npm run start:copy-docs.
5. Once you have got feedback on the docs, you can lock it in via ./plugins/api-docs/processedMap.js.