Skip to content

Commit f9f70fc

Browse files
committed
Update documentation for improved semantic clarity: Replace <Tip> with <Info> in multiple sections to enhance consistency and understanding of the content, while refining component usage guidelines in the contributing document.
1 parent 28bba9c commit f9f70fc

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ npm run build
6363
- Update the relevant docs in `docs/` when changing behavior or adding features.
6464
- For user-facing changes, update `README.md` and the docs at [docs.page/vypdev/copilot](https://docs.page/vypdev/copilot).
6565
- The project uses [docs.page](https://docs.page/) (invertase) for publishing; see `docs.json` for sidebar structure.
66-
- Use only **docs.page components** so the site builds without errors: **Card**, **CardGroup** (for multiple cards in a row; use `cols={2}` or `cols={3}`), **Callouts** (e.g. Info, Warning, Tip), **Tabs**, **Accordion**, **Steps**, **Code Group**, etc. Do **not** use Mintlify-only components such as **Columns** (use **CardGroup** instead). See [docs.page Components](https://use.docs.page/components).
66+
- Use only **docs.page components** so the site builds without errors: **Card**, **CardGroup** (for multiple cards in a row; use `cols={2}` or `cols={3}`), **Callouts** (**Info**, **Warning**, **Error**, **Success** only — do not use Note or Tip), **Tabs**, **Accordion**, **Steps**, **Code Group**, etc. Do **not** use Mintlify-only components such as **Columns** (use **CardGroup** instead). See [docs.page Components](https://use.docs.page/components).
6767

6868
## Submitting Changes
6969

docs/features.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@ Configuration: `opencode-server-url`, `opencode-model`, and optionally `opencode
109109

110110
## Workflow concurrency and sequential execution
111111

112-
<Tip>
112+
<Info>
113113
**Sequential runs:** When a new run starts, the action **waits** for any previous run of the **same workflow name** to finish. Runs of the same workflow (e.g. "Copilot - Issue") execute one after another instead of in parallel or being cancelled — something GitHub does not offer natively.
114-
</Tip>
114+
</Info>
115115

116116
GitHub's native [concurrency](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency) lets you cancel in-progress runs when a new one starts (`cancel-in-progress: true`). Copilot adds **sequential execution** for the same workflow: when a new run starts, the action waits for any previous run of the same workflow name to finish before doing its work.
117117

docs/pull-requests/ai-description.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ The AI is instructed to use your repository's **pull request template** as the s
2727

2828
If you don't have a template, the agent will still produce a structured description, but defining a template ensures consistent, professional PR descriptions that match your team's expectations (e.g. Summary, Related Issues, Scope of Changes, Technical Details, How to Test, Breaking Changes, Deployment Notes, etc.).
2929

30-
<Tip>
30+
<Info>
3131
**Recommendation:** Add a `.github/pull_request_template.md` in your repo with the sections you want (summary, scope, testing, breaking changes, etc.). The AI will use it as a guide and fill it with the information from the issue and the branch diff.
32-
</Tip>
32+
</Info>
3333

3434
## When the AI description runs
3535

docs/testing-opencode-plan-locally.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ node build/cli/index.js recommend-steps -i <issue-number> -t <PAT>
7777

7878
## 4. Optional: .env File
7979

80-
<Tip>
80+
<Info>
8181
You can store your token and OpenCode settings in a `.env` file so you don't need to pass `-t` and OpenCode options every time.
82-
</Tip>
82+
</Info>
8383

8484
Create a `.env` file in the repo root (do **not** commit it):
8585

0 commit comments

Comments
 (0)