docs: add support page, surface Discord, remove Airtable signup gate#23435
docs: add support page, surface Discord, remove Airtable signup gate#23435AztecBot wants to merge 1 commit into
Conversation
Adds a new "Get help & report issues" page at /developers/support with a decision tree for ask-first channels (Discord, Forum), reproducible bugs (GitHub bug_report.yml), Noir compiler bugs (noir-lang/noir), feature requests, docs issues, operator/node issues, and security disclosures (Cantina bounty, GitHub PVR, security@aztec.foundation). The security section is called out at the top of the page so a builder cannot miss it before filing publicly. Wires the page into the developer sidebar, the navbar Resources dropdown, and the footer Community section. Adds a "Need help?" tip admonition at the bottom of the developer overview and both getting-started pages. Removes the airtable.com/appMhZd7lsZS3v27R signup gate from the two places it appeared (the navbar Resources dropdown and the homepage QuickLinks) and replaces it with a direct discord.gg/aztec invite plus a link to the new support page. Also adds a direct Aztec Discord link to the footer Community section, which previously listed Forum + Noir Discord + X but not the main Aztec Discord. The support page is added to both the unversioned docs-developers/ and the v4.2.0 versioned snapshot so the footer link (rendered on every page across all docs instances) resolves against the default mainnet version.
critesjosh
left a comment
There was a problem hiding this comment.
Add the pages to the version-v4.3.0 docs instead of 4.2
|
|
||
| All of the components below live in [`AztecProtocol/aztec-packages`](https://github.com/AztecProtocol/aztec-packages), so use the bug template above and let triage attach the component label. | ||
|
|
||
| - **PXE, wallet, CLI**: `aztec`, `aztec-wallet`, `aztec.js`, `bb.js`, sandbox. |
There was a problem hiding this comment.
| - **PXE, wallet, CLI**: `aztec`, `aztec-wallet`, `aztec.js`, `bb.js`, sandbox. | |
| - **PXE, wallet, CLI**: `aztec`, `aztec-wallet`, `aztec.js`, `bb.js`, local network. |
| - **Open an issue** with the bug template and quote the URL and paragraph that needs fixing. | ||
| - **Open a pull request** directly. Every docs page in this site has an "Edit this page" link at the bottom that takes you to the right file in [`docs-developers/`](https://github.com/AztecProtocol/aztec-packages/tree/next/docs/docs-developers). | ||
|
|
||
| Small typo fixes are welcome as direct PRs without an issue first. For larger restructures, open an issue so a maintainer can confirm the direction before you write the change. |
There was a problem hiding this comment.
Historically we have discouraged typo fixes because it encourages low effort AI generated PRs that are more trouble to review than to just fix. Maybe we encourage typo issues instead, and automatically tag @AztecProtocol/devrel
|
|
||
| 1. **[Aztec Network Bug Bounty on Cantina](https://cantina.xyz/bounties/80e74370-10d8-4e52-8e4b-7294deb7c9ee)** if the issue is in scope of the bounty program. | ||
| 2. **[GitHub Private Vulnerability Reporting (PVR)](https://github.com/AztecProtocol/aztec-packages/security/advisories/new)** for any other suspected vulnerability. Go to the "Security" tab of the repository and click "Report a vulnerability". | ||
| 3. **Email `security@aztec.foundation`** if PVR is not available to you. Please do not include the exploit details or steps to reproduce in the email body, send those through PVR. |
There was a problem hiding this comment.
It says to use email if PVR is not available in the first sentence, then says to use PVR in the second.
|
|
||
| ## Operator and node issues | ||
|
|
||
| If you are running a node, sequencer, or prover and you hit an operational problem (sync failures, missed proposals, prover crashes, deployment errors), please include the following alongside the standard bug-report fields: |
There was a problem hiding this comment.
May be worth adding a link to discord at the top of this sub-heading? I know you link to them above, but if I click on the Operator support link in the table above, i jump straight here without seeing the discord link section. Another alternative could be to put the discord link section above the decision tree table
Summary
Implements Steps 1 and 2 of the issue-reporting v1 plan we've been discussing:
/developers/support(docs/docs-developers/support.md) with a decision tree for: ask-first channels (Discord, Forum), reproducible bugs (GitHubbug_report.yml), Noir compiler bugs (noir-lang/noir), feature requests (feature_request.yml), docs issues, operator/node issues, and security disclosures (Cantina bounty, GitHub PVR,security@aztec.foundation). The security section is called out at the top of the page and again as its own section so a builder cannot miss it before filing publicly.sidebars-developer.js) so it shows up alongside the getting-started pages.docusaurus.config.js).airtable.com/appMhZd7lsZS3v27R/pagxWYAHYYrnrrXmm/formsignup gate from the two places it appears (the navbar Resources dropdown and the homepage QuickLinks), and replaces it with a directhttps://discord.gg/aztecinvite plus a link to the new support page.:::tip Need help?admonition to the bottom of the two getting-started pages (getting_started_on_local_network.md,getting_started_on_testnet.md) and the Aztec overview, pointing at the new support page.Why
External builders today have no signposted path from
docs.aztec.networkto "if you hit a bug, do X". The footer doesn't even surface the main Aztec Discord, and the navbar's "Join community" link routes through an Airtable signup form rather than going directly to Discord. This means:from-communityissues on this repo are all self-filed without any docs-side guidance).This PR adds the missing signposts. It does not change any of the existing issue templates, labels, or triage process: it only makes the existing paths discoverable.
Test plan
yarnandyarn startfromdocs/and confirm the dev server boots without warnings./developers/supportand confirm the page renders, the decision-tree table is readable, and the security warning admonition is visible at the top.getting_started_on_local_networkandgetting_started_on_testnet, confirm the "Need help?" tip block renders at the bottom and the link to./support.mdworks.yarn buildsucceeds and produces no broken-link errors (the new internal links/developers/support,./support.md, and the existingdiscord.gg/aztecinvite are all reachable).Follow-ups (not in this PR)
These were also in the v1 plan but are scoped to separate PRs so this one stays focused:
operator_issue.ymlissue template with node-specific fields.bug_report.yml.P-medium,P-low,S-needs-repro,O-labs/O-wonderland/O-nethermind, etc.).aztec-starterconfig.ymlthat redirects issues to this repo.Once those land, the support page already references them by name, so the page will stay accurate without further edits.
Notes for reviewers
description:front-matter field onsupport.mdfollows the repo's docs style guide (under 160 chars, active voice).docs/CLAUDE.md.Created by claudebox · group:
slackbot