Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: link catalog #2027

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

feat: link catalog #2027

wants to merge 3 commits into from

Conversation

brendan-defi
Copy link
Collaborator

@brendan-defi brendan-defi commented Mar 18, 2025

What changed? Why?

  • added scripts to base-docs that catalog all links in all md/mdx files in docs/pages
  • options for pulling specifying all links or just broken links
  • options to return JSON or to build a CSV file

Notes to reviewers
Known shortcomings:

  • some sites do not allow HEAD fetching, returns some false-positives for external links
  • the script reports all mailto: links as broken
  • the script ignores anchor links eg docs.base.org/identity/smart-wallet/sdk/getting-started#parameters
    • this is because proving that the anchor exists requires scanning md/mdx file content
    • sometimes the files contain embedded sub-components. these sub-components are tricky to parse

How has it been tested?

Have you tested the following pages?

  • [] base.org
  • [] base.org/ecosystem
  • [] base.org/resources
  • [] base.org/build
  • [] base.org/names
  • [] base.org/name/jesse
  • [] base.org/manage-names

Copy link

vercel bot commented Mar 18, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
base-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 19, 2025 3:33am
web-base-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 19, 2025 3:33am

@cb-heimdall
Copy link
Collaborator

cb-heimdall commented Mar 18, 2025

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

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.

2 participants