Skip to content

Add some more metadata to other pages #8452#2099

Open
alhambrav wants to merge 3 commits into
craftercms:masterfrom
alhambrav:add-metadata
Open

Add some more metadata to other pages #8452#2099
alhambrav wants to merge 3 commits into
craftercms:masterfrom
alhambrav:add-metadata

Conversation

@alhambrav
Copy link
Copy Markdown
Member

Ticket reference or full description of what's in the PR

Add some more metadata to other pages craftercms/craftercms#8452

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 21, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: bd1e2849-f514-4574-a909-b17cafcf5d8e

📥 Commits

Reviewing files that changed from the base of the PR and between 257ac0d and 2a560ee.

📒 Files selected for processing (11)
  • source/by-role/developer/upgrade/index.rst
  • source/contribute/acknowledgements.rst
  • source/contribute/documentation-template.rst
  • source/contribute/index.rst
  • source/faq.rst
  • source/getting-started/index.rst
  • source/index.rst
  • source/reference/modules/studio.rst
  • source/release-notes/index.rst
  • source/roadmap.rst
  • source/support.rst

Summary by CodeRabbit

  • Documentation
    • Enhanced page metadata across multiple documentation sections including Getting Started, FAQ, Support, Roadmap, and Release Notes to improve search and content discoverability.
    • Updated Crafter Studio module documentation description to reflect current coverage of configuration, security, and administration topics.

Walkthrough

This PR standardizes Sphinx metadata across eleven documentation pages by adding or updating .. meta:: blocks with English-language page descriptions (:description lang=en:). The changes apply consistently to index pages, module references, and section landing pages, while two files modify existing description text.

Changes

Documentation SEO Metadata

Layer / File(s) Summary
Page description metadata updates
source/index.rst, source/by-role/developer/upgrade/index.rst, source/contribute/index.rst, source/contribute/acknowledgements.rst, source/contribute/documentation-template.rst, source/faq.rst, source/getting-started/index.rst, source/reference/modules/studio.rst, source/release-notes/index.rst, source/roadmap.rst, source/support.rst
Sphinx .. meta:: blocks with :description lang=en: are added to nine documentation pages and updated in two others (source/by-role/developer/upgrade/index.rst and source/reference/modules/studio.rst). All changes standardize page-level metadata for SEO purposes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • craftercms/docs#2098: Updates Sphinx .rst pages by adding/updating .. meta:: SEO :description: and :keywords: blocks, following the same metadata tag pattern.

Suggested reviewers

  • sumerjabri
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Add some more metadata to other pages #8452' is directly related to the main change—adding metadata to multiple documentation pages across the repository.
Description check ✅ Passed The description includes a ticket reference (issue #8452) and mentions the purpose of adding metadata, following the template structure. However, it lacks detail about which pages are affected or what metadata changes were made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@alhambrav alhambrav marked this pull request as ready for review May 21, 2026 11:21
@alhambrav
Copy link
Copy Markdown
Member Author

@sumerjabri This is ready

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