Commit Graph
9 Commits
Author SHA1 Message Date
Miranda Limonczenko 1608b16687 chore(docs) Direct contributors to the docs authoring skills (#50600)
Prerequisite for
[DOCS-1289](https://linear.app/supabase/issue/DOCS-1289/get-the-linter-to-fix-what-it-flags-or-retirereplace-the-linter).

## Problem

The `write-the-docs` and `edit-the-docs` skills carry the docs style
guide, so a contributor who uses them writes to the guide without having
read it. Right now nothing points a contributor at them.
`apps/docs/CONTRIBUTING.md` describes the skills as an option for agent
users, halfway down a 559-line page, and no other contributor-facing
file mentions them at all.

## Solution

- **CodeRabbit reminder.** One path instruction for
`apps/docs/content/**/*.mdx`. When a page collects two or more style,
terminology, or structure issues, CodeRabbit adds a single comment
pointing the author at `/write-the-docs` or `/edit-the-docs`. A single
nit gets no pointer, so the comment reads as a signal rather than
boilerplate.
- **Docs CONTRIBUTING.** The intro lists the skills by task, draft
through self-review, before the style rules, and links the existing
skills section for framing and architecture. The section opener now
reads as an expectation rather than a conditional, with the agent
mechanics moved to a second paragraph.
- **Root CONTRIBUTING.** A pre-flight check under Pull Requests, with
the same task list nested under it. Matches the docs checklist item in
#50591.
- **Word list.** Names the skills that apply the list.
- **Docs README and DEVELOPERS.** One sentence in each Contributing
section.

**Not in this PR:** CodeRabbit reminds, it doesn't enforce. Feeding the
two `SKILL.md` files to `knowledge_base.code_guidelines` would make it
review docs content against the style guide. That's a decision for
DOCS-1289 itself.

**Verification caveat:** this PR changes no MDX under
`apps/docs/content/`, so the new path instruction doesn't fire on its
own review.

## Manual testing

1. See all new content references in the diff.
2. Review for clarity and value.
3. Consider suggesting other ways to promote the usage of this skill to
all docs contributors.
2026-09-21 10:07:21 -07:00
Chris Chinchilla a40252e6c1 docs: Update contribution docs (#42402)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Simplified the local setup instructions for running the docs site
during development.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-05-29 15:55:10 +02:00
Terry SuttonandCharis Lam bb0306061d Chore/update to next 15 (#30075)
* Update Next.js docs for v15

* More awaiting

* remove async for pages router

* fix for dashboard connection guide

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2024-10-24 12:56:20 -02:30
Charis 3b781ab6bb update and streamline all the docs readmes (#20201) 2024-01-08 13:49:42 -05:00
Clarence 4dda2ad7ac update README.md (#19982) 2024-01-03 10:23:59 +00:00
Terry Sutton 3a78460b76 Update readme and developers docs 2022-11-03 14:29:10 -02:30
Joshen Lim 986cccb9b1 Rename temp docs to docs 2022-11-03 20:40:03 +07:00
Copple f83c1ca018 renames folders 2022-04-26 12:44:07 +02:00
Copple 8c4993a3be init turbo 2022-04-18 17:26:20 +02:00