From 98aecca671915caa68fbc9d3c35e06eebdfcab9e Mon Sep 17 00:00:00 2001 From: fuma-nama Date: Wed, 12 Jun 2024 16:12:09 +0800 Subject: [PATCH] Rewrite guides --- .github/contributing.md | 40 +++++++++++++++++++ README.md | 16 +------- .../content/docs/headless/mdx/rehype-code.mdx | 2 +- 3 files changed, 43 insertions(+), 15 deletions(-) create mode 100644 .github/contributing.md diff --git a/.github/contributing.md b/.github/contributing.md new file mode 100644 index 000000000..9b9863d7a --- /dev/null +++ b/.github/contributing.md @@ -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. \ No newline at end of file diff --git a/README.md b/README.md index 611c17126..fe0cbfbdf 100644 --- a/README.md +++ b/README.md @@ -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**. @@ -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. diff --git a/apps/docs/content/docs/headless/mdx/rehype-code.mdx b/apps/docs/content/docs/headless/mdx/rehype-code.mdx index cc9a91b12..15cef478e 100644 --- a/apps/docs/content/docs/headless/mdx/rehype-code.mdx +++ b/apps/docs/content/docs/headless/mdx/rehype-code.mdx @@ -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