📖 Welcome to Usher Documentation repository

Welcome to the Usher documentation repository! Here, our goal is to help our users unleash the full potential of Usher, allowing them to effectively manage and grow their partner networks, streamline referral programs, and seamlessly integrate Usher into their Web2 and Web3 projects.

For more information about the Usher project, its source code, and technical details, please visit the Usher Organization Profile. You will find the Usher Core, Usher.js, and Usher Programs components repositories, along with instructions on how to set up and deploy your instance of Usher.

This website is built using Docusaurus 2, a modern static website generator designed to make it easy for developers to create and maintain documentation sites.

Get started

Installation

$ pnpm install

Local Development

$ pnpm start

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

Customization

Creating and organizing content

• Store content in the docs directory, supporting .md and .mdx files. Learn more →
• Configure each folder metadata accordingly, using_category_.json or_category_.yml. Learn more →
• Utilize frontmatter options for configuration and customization. See the API here →
• Set a specific page as the main page [link] (if you do not intend to create a dedicated homepage. Otherwise, to create a homepage learn more here)
• Configure header navigation items in the docusaurus.config.js file. Learn more →
• Create multiple sidebars by updating sidebars.js according to your docs folder structure. Learn more →

Example of a tree structure in the docs folder:

docs
├── getting-started
│   ├── introduction.md
│   └── installation.md
└── guides
    ├── configuration.md
    └── customization.md

Using the autogenerated sidebar:

module.exports = {
	sidebars: {
		gettingStarted: [
			{
				type: "autogenerated",
				dirName: "getting-started"
			}
		],
		guides: [
			{
				type: "autogenerated",
				dirName: "guides"
			}
		]
	}
};

This will generate separate sidebars for the getting-started and guides folders. Adjust the header navigation items in docusaurus.config.js accordingly.

Ensure you update both the sidebars.js file and the header navigation items in docusaurus.config.js when changing the documentation structure, providing a seamless navigation experience for users.

Customization

Basic customization

• Change fonts following instructions at tailwind.config.ts
• Modify typography settings at tailwind.config.ts
• Update colors at tailwind.config.ts

Advanced customization

• Apply component-specific styles at specific module.css files
• Use mdx and React. Learn more →
• Swizzle built-in components or update our modifications at src/theme/* files. Learn more about Swizzling →
• Develop custom React pages at src/pages. Learn more →

Best practices

• When swizzling components, add comments to indicate where changes occurred
• Follow Docusaurus-specific best practices for versioning and customization. Learn more →

Deployment

Build

$ pnpm build

This command generates static content into the build directory and can be served using any static contents hosting service.

Contributing to this documentation

We welcome contributions to improve and expand the documentation for {project-name}. Here's how you can contribute:

1. Report issues: If you find any errors, inconsistencies, or areas that need improvement, please open an issue on the GitHub main repository. Provide a clear description of the issue and suggest a possible solution or improvement.
2. Suggest enhancements: If you have ideas for new sections, topics, or content that would be helpful to others, please share your suggestions by opening an issue on the GitHub main repository.
3. Submit a pull request: If you'd like to contribute directly by fixing an issue or adding new content, please fork the repository, make changes, and submit a pull request. Ensure your changes follow the documentation guidelines and best practices outlined in the README.

Note: If you want to contribute to Usher source code itself, please visit the Usher main repository and follow the contribution guidelines.