Skip to content

docs(applications): rework the Applications section to the current style guide - #2660

Merged
marcus-souza-azion merged 1 commit into
mainfrom
docs/applications-rework
Nov 18, 2026
Merged

marcus-souza-azion merged 1 commit into
mainfrom
docs/applications-rework

Conversation

@marcus-souza-azion

@marcus-souza-azion marcus-souza-azion commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

What & why

Related issue: none
Pages affected: /en/documentation/platform/applications/** (Overview, How it works, Limits, Glossary, Best practices, Troubleshooting, and the reference pages First steps, Main settings, Rules Engine, Device groups, WebSocket, Function instances, Cache settings, Real-Time Purge, L2 caching), /en/documentation/platform/applications/cache/**, /en/documentation/platform/applications/application-accelerator/**, /en/documentation/platform/applications/image-processor/**, the Applications guides hub, and the Trusted CA size link in edge-application/domains/mtls; each with its PT pair.

Rebased on #2659, which created the Certificate Manager and Custom Pages sections that 22 links here point at. The rebase kept this PR's version of the two Applications Overviews; every file matches the reviewed version.

The four Overviews follow the new shape. Applications, Cache, Application Accelerator and Image Processor each have:

  • a definition block of at most four sentences;
  • a list (Applications only, since Application Accelerator and Image Processor have no nested resource or Feature page);
  • CTAs, ## Request path and a router.

The old ## Resources, specimen and scope blocks left the Overviews.

  • Specimens: now on the settings pages.
  • Scope and limits: now under ## Scope on Limits, with a ### Scope for each nested resource.
  • Interfaces: the five Console tabs and Terraform are in a new ## Interfaces section of Main Settings.

Every page of the section was reviewed and its findings applied.

  • Repeated facts are said once.
  • First sentences answer their heading.
  • Concept pages carry no Console paths.
  • variation has one definition.
  • ims has one name.
  • The glossary's #cache, #application-accelerator and #image-processor links now point at each nested Overview.
  • No fact was dropped, and no permalink or namespace changed.

How I checked it.

  • Each page was reviewed against the azion-docs-writer rules, the findings were applied, and four re-readers checked every page again. An independent read-only review ran last, and its findings were fixed.
  • docs_gate.py --check --cross: no P0, and 0 findings on the 58 section pages.
  • pnpm lint:codeblocks on the changed pages (60 files after the rebase): no issues.
  • npx prettier --check: clean.
  • pnpm lint:navcheck: passes.
  • A link script resolved all 1,716 internal links and their fragments. After the rebase, linkcheck.py reports no broken link in the section; the 8 it reports in the previous-years changelogs are on main too.
  • I opened the pages on the local dev server together with feat(platform): give Certificate Manager and Custom Pages their own sections and rework Workloads #2659.
  • Not verified: I did not run pnpm build:local. The pages are the source of truth, so no fact was rechecked against the live API or Console.

Type of change

  • 🆕 New content (feat)
  • 🩹 Fix (fix) — typo, broken link, wrong information
  • ♻️ Content update (docs) — rewrite, expansion, upkeep
  • 🌐 Translation sync (i18n)
  • 🏗️ Platform / structure (refactor / chore) — reviewed by UXE, no content mixed in

Author checklist

  • PR title follows type(scope): summary (see GOVERNANCE.md §4)
  • Frontmatter complete: title, description, meta_tags, namespace, permalink, last_reviewed — every page carries the first five; last_reviewed is on no page in the corpus
  • No legacy "edge-" product names in the copy
  • How-to/tutorial content includes at least one runnable, copy-paste-tested code block — the quickstarts keep their existing code blocks; none was run in this PR
  • Screenshots (if any) have alt text and follow image standards — no screenshot is added or changed
  • Internal links are relative and resolve locally
  • If any permalink changed or page moved: redirect added in this PR — no permalink changed and no page moved
  • i18n: pt-br updated in this PR or follow-up i18n issue created: every page is changed in both languages
  • I ran pnpm build:local (build + frontmatter check) without errors — not run; the reviewer runs the build

Rebuild the Applications, Cache, Application Accelerator and Image Processor
Overviews in the current shape, add Scope to Limits, and apply the review
findings to every page of the section. Interfaces move to Main Settings,
and links to Certificate Manager and Custom Pages use their new sections.
@marcus-souza-azion
marcus-souza-azion merged commit e714cd2 into main Nov 18, 2026
10 checks passed
@marcus-souza-azion
marcus-souza-azion deleted the docs/applications-rework branch November 18, 2026 00:30
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