Skip to content

docs: enhance README with contribution guide and live site link #433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: enhance README with contribution guide and live site link #433

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
df0329c
Update README.md
DeVikingMark Apr 3, 2025
3bfd42a
Update README.md
meerkat-monkey May 20, 2025
b194128
Merge branch 'main' into readme-enhance
meerkat-monkey May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

An advanced, streamlined documentation platform built with Next.js and Nextra for InkChain.

## 🔗 Live Documentation

Visit our [live documentation site](https://docs.inkonchain.com) to see the latest published version.

## 🚀 Build & Run

1. **Build Docker image**:
Expand All @@ -29,6 +33,10 @@ This is a documentation application powered by [Nextra](https://nextra.site/) an
To get started with local development:

1. **Clone the repository**
```bash
git clone https://github.com/inkchain/docs.git
cd docs
```
2. **Install dependencies**:
```bash
pnpm install
Expand All @@ -37,6 +45,7 @@ To get started with local development:
```bash
pnpm run dev
```
4. **Open your browser** at http://localhost:3000

## 🛠 Tooling

Expand Down Expand Up @@ -64,3 +73,18 @@ For every new PR, our CI/CD pipeline deploys a temporary environment via **AWS A
## 🚀 Production Deployment

The `main` branch is configured for automatic continuous deployment via **AWS Amplify**. Every merge triggers a new build and deployment, ensuring that the latest version of the documentation is available to users without manual intervention.

## 👥 How to Contribute

We welcome contributions from the community! To contribute to this documentation:

1. **Fork the repository** and create your feature branch
2. **Make your changes** following our code style guidelines
3. **Run tests locally** to ensure everything works properly:
```bash
pnpm run lint
pnpm run spell-check
```
4. **Submit a pull request** with a clear description of your changes

Please refer to our [Contribution Guidelines](CONTRIBUTING.md) for more detailed information.