From 50044100bdaefda3d3d6815278dfbd6032da8944 Mon Sep 17 00:00:00 2001 From: Youssef Date: Thu, 8 Oct 2026 13:47:56 +0100 Subject: [PATCH] docs(contributing): document PR base branch, MDX rule and fix security page descriptions --- README.md | 2 +- docs/contribution-guidelines.md | 9 +++++++++ docs/llms-full.txt | 4 ++-- docs/llms.txt | 4 ++-- docs/specifications/security/avoid-malicious-flags.mdx | 2 +- docs/specifications/security/report-a-vulnerability.mdx | 2 +- 6 files changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d3d19bbbb..b46ee1e10 100644 --- a/README.md +++ b/README.md @@ -151,7 +151,7 @@ If your goal is to increase discoverability of your product, please request incl ## Submission process -1. Create a PR to `https://github.com/base/docs` with your changes. +1. Create a PR to `https://github.com/base/docs` against the `master` branch. Create new pages as `.mdx` files; the `Docs Style / Conformance` check only lints `.mdx` pages under `docs/`. See [contribution-guidelines.md](docs/contribution-guidelines.md#opening-a-pull-request). 2. Include a clear description of the change and impacted pages. 3. Request review from the docs team. 4. Address feedback and iterate. diff --git a/docs/contribution-guidelines.md b/docs/contribution-guidelines.md index 635fe4bd9..b5283e50a 100644 --- a/docs/contribution-guidelines.md +++ b/docs/contribution-guidelines.md @@ -236,12 +236,21 @@ Structural changes to the information architecture — adding tabs, renaming sec --- +## Opening a Pull Request + +- **Base branch**: `master` is the default branch of [base/docs](https://github.com/base/docs). Branch from `master` (in your fork) and open your pull request against `master`. +- **Page format**: Create new pages as `.mdx` files under `docs/`. The `Docs Style / Conformance` check lints only the `.mdx` files under `docs/` that your pull request changes, and orphan detection in `scripts/validate-docs-structure.js` only scans `.mdx` files, so a page saved as `.md` skips both checks. +- **Snippets and excluded files**: Files in `docs/snippets/` and files listed in `docs/.mintignore` are not published pages, so page-level lint rules do not apply to them. + +--- + ## Before Submitting 1. **Run the linter** and fix all errors ```bash node scripts/lint-mdx.js ``` + With no arguments, the linter checks the `.mdx` files your branch changes relative to `master`. 2. **Add redirects** for any removed or moved pages 3. **Verify links** work — broken links block deployment 4. **Preview locally** with `mintlify dev` to check rendering diff --git a/docs/llms-full.txt b/docs/llms-full.txt index 6625f06c8..7c96a8a92 100644 --- a/docs/llms-full.txt +++ b/docs/llms-full.txt @@ -384,9 +384,9 @@ const client = createPublicClient({ chain: base, transport: http() }) - [Security Council for Base](https://docs.base.org/specifications/security/security-council-for-base): This page outlines the purpose, goals, structure, and responsibilities of the Security Council for Base. -- [How to Avoid Getting Your App Flagged as Malicious](https://docs.base.org/specifications/security/avoid-malicious-flags): The Base bug bounty program and procedures for reporting vulnerabilities. +- [How to Avoid Getting Your App Flagged as Malicious](https://docs.base.org/specifications/security/avoid-malicious-flags): Best practices for keeping wallets and security tools from flagging your app as malicious, and how to report a false positive. -- [Reporting Vulnerabilities](https://docs.base.org/specifications/security/report-a-vulnerability): The Base procedures for reporting vulnerabilities. +- [Reporting Vulnerabilities](https://docs.base.org/specifications/security/report-a-vulnerability): The Base bug bounty programs on HackerOne and Cantina, and how to report a security vulnerability. ## SDKs & APIs diff --git a/docs/llms.txt b/docs/llms.txt index 344bc9b2d..13102cd4b 100644 --- a/docs/llms.txt +++ b/docs/llms.txt @@ -318,9 +318,9 @@ - [Security Council for Base](https://docs.base.org/specifications/security/security-council-for-base): This page outlines the purpose, goals, structure, and responsibilities of the Security Council for Base. -- [How to Avoid Getting Your App Flagged as Malicious](https://docs.base.org/specifications/security/avoid-malicious-flags): The Base bug bounty program and procedures for reporting vulnerabilities. +- [How to Avoid Getting Your App Flagged as Malicious](https://docs.base.org/specifications/security/avoid-malicious-flags): Best practices for keeping wallets and security tools from flagging your app as malicious, and how to report a false positive. -- [Reporting Vulnerabilities](https://docs.base.org/specifications/security/report-a-vulnerability): The Base procedures for reporting vulnerabilities. +- [Reporting Vulnerabilities](https://docs.base.org/specifications/security/report-a-vulnerability): The Base bug bounty programs on HackerOne and Cantina, and how to report a security vulnerability. ## SDKs & APIs diff --git a/docs/specifications/security/avoid-malicious-flags.mdx b/docs/specifications/security/avoid-malicious-flags.mdx index 7576bbb5b..9aace3150 100644 --- a/docs/specifications/security/avoid-malicious-flags.mdx +++ b/docs/specifications/security/avoid-malicious-flags.mdx @@ -1,7 +1,7 @@ --- sidebarTitle: 'Avoid Malicious Flags' title: How to Avoid Getting Your App Flagged as Malicious -description: The Base bug bounty program and procedures for reporting vulnerabilities. +description: Best practices for keeping wallets and security tools from flagging your app as malicious, and how to report a false positive. --- Ensuring that your app is perceived as trustworthy and not flagged as malicious requires attention to best practices. Here’s a quick guide on how to build a secure and compliant app from day one. diff --git a/docs/specifications/security/report-a-vulnerability.mdx b/docs/specifications/security/report-a-vulnerability.mdx index 8c458ab3c..747f9806c 100644 --- a/docs/specifications/security/report-a-vulnerability.mdx +++ b/docs/specifications/security/report-a-vulnerability.mdx @@ -1,7 +1,7 @@ --- sidebarTitle: 'Report a Vulnerability' title: Reporting Vulnerabilities -description: The Base procedures for reporting vulnerabilities. +description: The Base bug bounty programs on HackerOne and Cantina, and how to report a security vulnerability. --- ## Bug Bounty Program