Skip to content

Commit

Permalink
Rewrite guides
Browse files Browse the repository at this point in the history
  • Loading branch information
fuma-nama committed Jun 12, 2024
1 parent 053609d commit 98aecca
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 15 deletions.
40 changes: 40 additions & 0 deletions .github/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## Contributing Guide

We greatly appreciate your willingness to contribute to this project!
Before submitting a pull request, there are some guidelines you should notice.

### Guidelines

This project is a monorepo using Turborepo, pnpm and
[Changesets](https://github.com/changesets/changesets).

#### Before Submitting

- Check if there's other similar PRs.
- Format your code with `pnpm run prettier`.
- Add changesets with `pnpm changeset`, which documents the changes you've made.
- Run unit tests with `pnpm test` and update snapshots if necessary.

#### New Feature

Before submitting a new feature, make sure to open an issue (Feature Request) with sufficient information and reasons about the new feature.
After the feature request is approved, you can submit a pull request.

#### Bug Fixes

Provide a detailed description of the bug (with live demo if possible).
OR open a bug report and link it in your PR.

#### Docs

Contributing to the docs is relatively easier, make sure to check the typos and grammatical mistakes before submitting.

### New to contributing?

You may start with contributing to the docs,
it is located in `/apps/docs/content/docs`.

To run the docs site in dev mode,
build the dependencies with `pnpm run build --filter=./packages/*` and run `pnpm run dev --filter=docs` to start the dev server.

You don't need any extra environment variables to run this project.
16 changes: 2 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The framework for building documentation websites in Next.js.

📘 Learn More: [Documentation](https://fumadocs.vercel.app).

## Compatiability
## Compatibility

All packages are **ESM only**.

Expand All @@ -16,16 +16,4 @@ Welcome to print it out :D

## Contributions

We are welcome for contributions! You may start with contributing to the docs,
it is located in `/apps/docs/content/docs`.

To run the docs site in dev mode,
build the dependencies with `pnpm run build --filter=./packages/*` and run `pnpm run dev --filter=docs` to start the dev server.

Notice that this project is a monorepo using Turborepo, pnpm and
[Changesets](https://github.com/changesets/changesets). Make sure to format your
code with `pnpm run prettier` and add changeset with `pnpm changeset`.

### Environment Variables

You don't need any extra environment variables to run this project locally.
Make sure to read the [Contributing Guide](/.github/contributing.md) before submitting a pull request.
2 changes: 1 addition & 1 deletion apps/docs/content/docs/headless/mdx/rehype-code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Rehype Code
description: Code syntax highlighter
---

A built-in syntax highlighter based on [Shiki](https://shiki.style).
A wrapper of [Shiki](https://shiki.style), the built-in syntax highlighter.

## Usage

Expand Down

0 comments on commit 98aecca

Please sign in to comment.