Skip to content

seo: publish the rule reference on the Pages site - #128

Merged
FROWNINGdev merged 1 commit into
mainfrom
seo/publish-rule-docs
Sep 28, 2026
Merged

FROWNINGdev merged 1 commit into
mainfrom
seo/publish-rule-docs

Conversation

@FROWNINGdev

Copy link
Copy Markdown
Owner
  • Pages homepage links to docs/rules/{blast-radius,drift,nplusone}.md returned 404 because docs/ was excluded from the Jekyll build.
  • Now docs/rules is published (21 pages), each with a unique title from its H1 via jekyll-titles-from-headings.
  • DOL012.md and blast-radius.md stay excluded: they contain {{ ... }} that Liquid would silently blank; links to them now point at GitHub.
  • docs/i18n stays excluded.

The Pages homepage linked to docs/rules/{blast-radius,drift,nplusone}.md,
but docs/ was excluded from the build, so all three links returned 404.
Publishing docs/rules fixes them and gives the site pages of its own:
each rule answers a question people search for (.count() > 0 vs
.exists(), datetime.now() vs timezone.now(), N+1 in a loop), while the
homepage only duplicates the GitHub README.

DOL012.md and blast-radius.md stay out: they quote {{ ... }} (a Django
template variable, a GitHub Actions expression) that Liquid would render
as empty text. Links to those two now point at GitHub.
@coderabbitai

coderabbitai Bot commented Sep 28, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 25 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: aa9dc598-6469-426f-9bd6-f8e25ec49ad4

📥 Commits

Reviewing files that changed from the base of the PR and between e832665 and e713b15.

📒 Files selected for processing (4)
  • README.md
  • _config.yml
  • docs/rules/README.md
  • docs/rules/drift.md

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.

@FROWNINGdev
FROWNINGdev merged commit 726898c into main Sep 28, 2026
18 of 19 checks passed
@FROWNINGdev
FROWNINGdev deleted the seo/publish-rule-docs branch September 28, 2026 05:18
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