Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 9 additions & 0 deletions docs/contribution-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/llms-full.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/specifications/security/avoid-malicious-flags.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/specifications/security/report-a-vulnerability.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading