Skip to content

Polish documentation formatting and standardise structure#75

Merged
admdly merged 5 commits into
mainfrom
chore/cleanup
Jul 17, 2026
Merged

Polish documentation formatting and standardise structure#75
admdly merged 5 commits into
mainfrom
chore/cleanup

Conversation

@admdly

@admdly admdly commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Summary by cubic

Polished docs formatting, navigation, and examples for clearer guides, and moved GitHub Actions to ubuntu-slim for leaner CI.

  • Refactors

    • Adopted {% steps %} and {% filetree %} blocks across docs for consistent, scannable instructions.
    • Normalized code fences (text, twig) and cleaned up Twig examples (removed escape characters with clear “remove backslashes” notes).
    • Fixed internal links and anchors (added trailing slashes, corrected section anchors, updated paths and NGINX links).
    • Centralized the “breaking changes” caution into a reusable partial and applied it across development guides.
    • Improved tables and examples (e.g., ISO 8601 timestamps, corrected Twig API usage in theme docs), and set sidebar ordering for product-type pages.
    • Updated README with clearer redirect guidance and trimmed outdated sections; removed the outdated contributor code of conduct page.
    • Fixed manifest.json indentation in file tree examples.
  • CI

    • Updated ci and dependency-review workflows to run on ubuntu-slim.

Written for commit 18e0d26. Summary will update on new commits.

@admdly admdly self-assigned this Jul 17, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 17, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
docs 18e0d26 Commit Preview URL

Branch Preview URL
Jul 17 2026, 05:50 PM

@cubic-dev-ai cubic-dev-ai Bot 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.

All reported issues were addressed across 41 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread src/content/docs/admin-guide/invoice-pdf.mdoc
Comment thread .github/workflows/ci.yml Outdated
Comment thread src/content/docs/extensions-and-development/guides/creating-a-theme.mdoc Outdated
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>

@cubic-dev-ai cubic-dev-ai Bot 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.

0 issues found across 1 file (changes from recent commits).

Requires human review: Auto-approval blocked by 2 unresolved issues from previous reviews.

Re-trigger cubic

@cubic-dev-ai cubic-dev-ai Bot 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.

0 issues found across 1 file (changes from recent commits).

Auto-approved: The PR polishes documentation formatting (adopts steps/filetree blocks, normalizes code fences, fixes links) and trims CI runner; no functional changes to behavior, APIs, or operational logic. These are clearly beneficial and bounded.

Re-trigger cubic

@admdly
admdly merged commit 316b9d3 into main Jul 17, 2026
9 checks passed
@admdly
admdly deleted the chore/cleanup branch July 17, 2026 17:52
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.

1 participant