diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 56263d51c2..5e425c410d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -243,7 +243,7 @@ npm run test:e2e ``` For more detailed information on the integration testing framework, please see -the [Integration Tests documentation](./docs/integration-tests.md). +the [Integration Tests documentation](/docs/integration-tests.md). ### Linting and preflight checks @@ -472,7 +472,7 @@ code. ### Documentation structure -Our documentation is organized using [sidebar.json](docs/sidebar.json) as the +Our documentation is organized using [sidebar.json](/docs/sidebar.json) as the table of contents. When adding new documentation: 1. Create your markdown file **in the appropriate directory** under `/docs`. @@ -524,7 +524,7 @@ Before submitting your documentation pull request, please: If you have questions about contributing documentation: -- Check our [FAQ](docs/faq.md). +- Check our [FAQ](/docs/faq.md). - Review existing documentation for examples. - Open [an issue](https://github.com/google-gemini/gemini-cli/issues) to discuss your proposed changes. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 120000 index 0000000000..44fcc63439 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1 @@ +../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/sidebar.json b/docs/sidebar.json index 80e2494e4b..c9fd3e16b1 100644 --- a/docs/sidebar.json +++ b/docs/sidebar.json @@ -9,6 +9,10 @@ { "label": "Architecture Overview", "slug": "docs/architecture" + }, + { + "label": "Contribution Guide", + "slug": "docs/contributing" } ] },