Skip to content

Add per-product audits pages - #2737

Draft
leighmcculloch wants to merge 11 commits into
mainfrom
add-product-audits-pages
Draft

Add per-product audits pages#2737
leighmcculloch wants to merge 11 commits into
mainfrom
add-product-audits-pages

Conversation

@leighmcculloch

@leighmcculloch leighmcculloch commented Aug 7, 2026

Copy link
Copy Markdown
Member

What

Add an Audits section under Networks, next to Software Versions, with a page per product — Stellar Core, Soroban Host Environment, Soroban Rust SDK — each holding a version-to-audit-report table.

Screenshot 2026-08-07 at 2 13 40 pm

Why

Published audit reports aren't listed anywhere in the docs, so there's no way to tell which version of a product was audited or by whom. Tables are seeded with a placeholder row only, to be filled in with the real audit entries.

@stellar-jenkins-ci

Copy link
Copy Markdown

1 similar comment
@stellar-jenkins-ci

Copy link
Copy Markdown

@stellar-jenkins-ci

Copy link
Copy Markdown

@leighmcculloch
leighmcculloch requested a lite review from Copilot and removed request for Copilot August 7, 2026 04:11
@stellar-jenkins-ci

Copy link
Copy Markdown

@stellar-jenkins-ci

Copy link
Copy Markdown

@JFWooten4 JFWooten4 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extremely happy to see this. Refs: stellar/stellar-protocol#1979 (comment)

Comment on lines +6 to +7

# Soroban Rust SDK

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The page automatically renders a header title which matches the frontmatter title. This came up in #2673 (review), and we are trying to get rid of the duplicative declaration (which can also drift from updated page titles). I'd suggest removing it for a cleaner editing experience decluttered from redundancy.

Suggested change
# Soroban Rust SDK

Comment on lines +6 to +7

# Stellar Core

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same nit (src)

Suggested change
# Stellar Core

Comment on lines +6 to +7

# Soroban Host Environment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the intent here and in docs/networks/audits/soroban-sdk.mdx to ever expand to network projects like the SDF-sponsored OZ contracts? I get wary anytime I see files with the same base prefix but no shared directory, creating disorganized scope.

Suggested change
# Soroban Host Environment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add section for capturing recent audits of software components

2 participants