Skip to content

Conversation

@VitorAEltz
Copy link
Contributor

Documentation Audit Report (EN)

Scope: Full explicit-path audit of /Users/vitor.eltz/git/docs/src/content/docs/en (720 files)
Branch: main vs origin/main (no code diff; explicit full-path review requested)
Status: UPDATES NEEDED

Code Changes Analyzed

  • No code changes between main and origin/main.
  • Audited all EN docs in /Users/vitor.eltz/git/docs/src/content/docs/en.
  • Validated internal docs links against in-repo permalinks and production URL resolution (www.azion.com, checked on February 11, 2026).

Documentation Issues

[MEDIUM] Broken internal link: Nextal guide path returns 404

Location: /Users/vitor.eltz/git/docs/src/content/docs/en/pages/devtools/azion-edge-runtime/compatibility/frameworks/template-showcase/nextjs/nextal.mdx:41
Related Code: /Users/vitor.eltz/git/docs/src/content/docs/en/pages/devtools/azion-edge-runtime/compatibility/frameworks/template-showcase/nextjs/nextal.mdx:5
Problem: The link target does not exist and returns HTTP 404.
Current Doc Says: /en/documentation/products/guides/nextal/
Code Actually Does: This page’s permalink is /documentation/products/templates/nextal/ (valid EN target: /en/documentation/products/templates/nextal/).
Suggested Update: Replace /en/documentation/products/guides/nextal/ with /en/documentation/products/templates/nextal/ (or remove the self-reference if redundant).

[MEDIUM] Broken internal link: secure digital certificate guide path returns 404

Location: /Users/vitor.eltz/git/docs/src/content/docs/en/pages/main-menu/reference/secure/edge-firewall/wildcard-lets-encrypt-certificates.mdx:96
Related Code: /Users/vitor.eltz/git/docs/src/content/docs/en/pages/secure-journey/transport-layer-security/digital-certificates.mdx:6
Problem: Linked guide path is invalid and returns HTTP 404.
Current Doc Says: /en/documentation/products/guides/secure/digital-certificate/
Code Actually Does: Existing guide permalink is /documentation/products/guides/secure/digital-certificates/ (plural).
Suggested Update: Replace with /en/documentation/products/guides/secure/digital-certificates/.

[MEDIUM] EN docs link to PT-BR page

Location:
/Users/vitor.eltz/git/docs/src/content/docs/en/pages/guides/marketplace/templates/bot-starter-kit.mdx:20
/Users/vitor.eltz/git/docs/src/content/docs/en/pages/guides/marketplace/templates/bot-with-firewall.mdx:20
/Users/vitor.eltz/git/docs/src/content/docs/en/pages/guides/marketplace/templates/bot-with-tor.mdx:22
Related Code: /Users/vitor.eltz/git/docs/src/content/docs/en/pages/guides/marketplace/integrations/bot-manager-lite.mdx:8
Problem: English pages route users to Portuguese content.
Current Doc Says: /pt-br/documentacao/produtos/guias/bot-manager-lite/
Code Actually Does: EN equivalent exists at /en/documentation/products/guides/bot-manager-lite/.
Suggested Update: Replace all three PT-BR links with /en/documentation/products/guides/bot-manager-lite/.

[LOW] Legacy Build URLs cause redirect hops (not canonical)

Location: e.g. /Users/vitor.eltz/git/docs/src/content/docs/en/homes/build-home.mdx:18
Related Code: /Users/vitor.eltz/git/docs/src/content/docs/en/pages/main-menu/reference/build/edge-application/edge-application.mdx:8
Problem: Many links use deprecated /build/edge-application/... paths.
Current Doc Says: /en/documentation/products/build/edge-application/...
Code Actually Does: Canonical permalinks are /en/documentation/products/build/applications/...; old links resolve via 301 redirects.
Suggested Update: Bulk-replace /en/documentation/products/build/edge-application/ with /en/documentation/products/build/applications/ (337 occurrences).

[LOW] Legacy Secure Firewall URLs cause redirect hops (not canonical)

Location: e.g. /Users/vitor.eltz/git/docs/src/content/docs/en/pages/secure-journey/firewall-advanced-configurations/manage-bots.mdx:13
Related Code: /Users/vitor.eltz/git/docs/src/content/docs/en/pages/main-menu/reference/secure/edge-firewall/edge-firewall.mdx:8
Problem: Many links use deprecated /secure/edge-firewall/... paths.
Current Doc Says: /en/documentation/products/secure/edge-firewall/...
Code Actually Does: Canonical permalinks are /en/documentation/products/secure/firewall/...; old links resolve via 301 redirects.
Suggested Update: Bulk-replace /en/documentation/products/secure/edge-firewall/ with /en/documentation/products/secure/firewall/ (162 occurrences).

[LOW] Additional legacy product paths redirect instead of linking canonical pages

Location: e.g. /Users/vitor.eltz/git/docs/src/content/docs/en/homes/deliver-home.mdx:19, /Users/vitor.eltz/git/docs/src/content/docs/en/pages/store-journey/sql/create-table.mdx:16
Related Code:
/Users/vitor.eltz/git/docs/src/content/docs/en/pages/main-menu/reference/deploy/edge-orchestrator/edge-orchestrator.mdx:10
/Users/vitor.eltz/git/docs/src/content/docs/en/pages/main-menu/reference/store/object-storage/index.mdx:9
/Users/vitor.eltz/git/docs/src/content/docs/en/pages/main-menu/reference/store/edge-sql/edge-sql.mdx:8
Problem: Legacy paths still work only through redirects.
Current Doc Says: Paths like /deploy/edge-orchestrator/, /store/edge-storage/, /store/edge-sql/, /secure/edge-connector/.
Code Actually Does: Canonical targets are /deploy/orchestrator/, /store/object-storage/, /store/sql-database/, /secure/connectors/.
Suggested Update: Bulk-rewrite these legacy prefixes to canonical forms (remaining 248 redirecting occurrences).

Missing Documentation

No missing feature documentation was identified in this path-based review.

Code Comment Issues

No stale/incorrect code comments found within the scoped documentation files.

Summary

  • Medium: 3 issue groups (5 affected links: 2 hard 404 + 3 cross-language mismatches)
  • Low: 3 issue groups (747 redirecting links across 93 unique legacy targets)

Recommended Actions

  1. Fix the 2 hard-broken links immediately (404s).
  2. Replace the 3 PT-BR links in EN pages with EN equivalents.
  3. Run a bulk canonicalization pass for legacy URL prefixes (build/edge-application, secure/edge-firewall, and other legacy families) to remove redirect hops.

Documentation Audit Report (PT-BR)

Scope: Full explicit-path audit of /Users/vitor.eltz/git/docs/src/content/docs/pt-br (723 files)
Branch: main vs origin/main (no code diff; full path review requested)
Status: UPDATES NEEDED

Code Changes Analyzed

  • No branch diff (main matches origin/main).
  • Audited all PT-BR docs in /Users/vitor.eltz/git/docs/src/content/docs/pt-br.
  • Validated internal links against local permalinks and production resolution (www.azion.com, checked on February 11, 2026).

Documentation Issues

[MEDIUM] Broken link in Next.js frameworks table (404)

Location: /Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/devtools/azion-edge-runtime/compatibilidade/frameworks/nextjs.mdx:47
Related Code: /Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/devtools/azion-edge-runtime/compatibilidade/frameworks/template-showcase/nextjs/nextal.mdx:5
Problem: PT-BR table links to a route that does not exist.
Current Doc Says: /pt-br/documentacao/produtos/templates/nextal/
Code Actually Does: Existing Nextal page permalink is /documentation/products/templates/nextal/ (live at /pt-br/documentation/products/templates/nextal/).
Suggested Update: Point to the existing route (/pt-br/documentation/products/templates/nextal/) or normalize the Nextal permalink to PT-BR URL structure and update references consistently.

[MEDIUM] Broken “guia do template” link in Nextal page (404)

Location: /Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/devtools/azion-edge-runtime/compatibilidade/frameworks/template-showcase/nextjs/nextal.mdx:41
Related Code: /Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/devtools/azion-edge-runtime/compatibilidade/frameworks/template-showcase/nextjs/nextal.mdx:5
Problem: Linked guide path is missing and returns 404.
Current Doc Says: /pt-br/documentacao/produtos/guias/nextal/
Code Actually Does: No PT-BR guide exists at that path; the available Nextal page is /pt-br/documentation/products/templates/nextal/.
Suggested Update: Replace with a valid existing PT-BR destination (for example /pt-br/documentation/products/templates/nextal/) or create the missing guide page.

[MEDIUM] PT-BR docs link to EN pages where PT-BR equivalents already exist

Location:
/Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/guias/edge-storage/bucket-actions/index.mdx:144
/Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/menu-principal/release-notes/release-notes.mdx:538
Related Code:
/Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/devtools/azion-edge-runtime/api-reference/object-storage/object-storage.mdx:6
/Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/devtools/azion-edge-runtime/runtime-apis/index.mdx:9
Problem: PT-BR pages send users to EN docs even though PT-BR pages exist.
Current Doc Says: /en/documentation/runtime/api-reference/storage/, /en/documentation/runtime-apis/javascript/
Code Actually Does: PT-BR equivalents exist at /pt-br/documentacao/runtime/api-reference/storage/ and /pt-br/documentacao/runtime-apis/javascript/.
Suggested Update: Replace EN links with PT-BR equivalents.

[LOW] Legacy Build URLs resolve only via redirects

Location: e.g. /Users/vitor.eltz/git/docs/src/content/docs/pt-br/homes/build-home.mdx:18
Related Code: /Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/menu-principal/referencia/build/edge-application/edge-application.mdx:9
Problem: Many links still use /build/edge-application/... legacy paths.
Current Doc Says: /pt-br/documentacao/produtos/build/edge-application/...
Code Actually Does: Canonical paths are /pt-br/documentacao/produtos/build/applications/...; old paths redirect.
Suggested Update: Bulk-replace this prefix to canonical form (355 occurrences).

[LOW] Legacy Secure Firewall URLs resolve only via redirects

Location: e.g. /Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/arquiteturas/security-modernization/security-modernization-com-edge-computing.mdx:45
Related Code: /Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/menu-principal/referencia/secure/edge-firewall/edge-firewall.mdx:8
Problem: Many links still use /secure/edge-firewall/... legacy paths.
Current Doc Says: /pt-br/documentacao/produtos/secure/edge-firewall/...
Code Actually Does: Canonical paths are /pt-br/documentacao/produtos/secure/firewall/...; old paths redirect.
Suggested Update: Bulk-replace to canonical /secure/firewall/... (163 occurrences).

[LOW] Additional legacy product paths redirect to canonical routes

Location: e.g. /Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/arquiteturas/orch/application-deliver-automation.mdx:11, /Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/arquiteturas/edge-enhanced/edge-enhanced.mdx:39
Related Code:
/Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/menu-principal/referencia/deploy/edge-orchestrator/edge-orchestrator.mdx:9
/Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/menu-principal/referencia/store/edge-storage/index.mdx:11
/Users/vitor.eltz/git/docs/src/content/docs/pt-br/pages/menu-principal/referencia/store/edge-sql/edge-sql.mdx:9
Problem: Multiple legacy families still depend on redirects (deploy/edge-orchestrator, store/edge-storage, store/edge-sql, secure/edge-connector, etc.).
Suggested Update: Canonicalize remaining legacy prefixes (209 occurrences).

Missing Documentation

No additional missing documentation sections were identified beyond the broken Nextal guide reference above.

Code Comment Issues

No stale/incorrect code comments found in the scoped PT-BR documentation files.

Summary

  • Medium: 3 issue groups (4 affected links)
  • Low: 3 issue groups (727 redirecting link occurrences across 76 unique targets)

Related Concerns

  • I found 80 PT-BR pages linking to EN URLs where I could not prove a PT-BR equivalent path from local permalinks. These may be intentional fallback links, so I did not classify them as findings.

Recommended Actions

  1. Fix the 2 hard 404 Nextal links first.
  2. Replace the 2 EN links that already have PT-BR equivalents.
  3. Run a bulk canonicalization pass for PT-BR legacy link prefixes to remove redirect dependencies.

Update internal documentation links across architecture guides and home pages to align with new product URL paths. Changes include:
- edge-application → applications
- edge-firewall → firewall
- edge-orchestrator → orchestrator
- edge-storage → object-storage
- edge-sql → sql-database
- edge-connector → connectors
- network-layer-protection → network-shield
- edge-functions → functions

Remove trailing blank lines from
@VitorAEltz VitorAEltz requested a review from a team as a code owner February 11, 2026 20:37
@VitorAEltz VitorAEltz requested a review from arturdj February 11, 2026 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant