Skip to content

Docs: Add robots.txt, llms.txt and update documentation urls - #377

Open
solid-illiaaihistov wants to merge 11 commits into
solid-software:masterfrom
solid-illiaaihistov:docs/add-robots-txt
Open

solid-illiaaihistov wants to merge 11 commits into
solid-software:masterfrom
solid-illiaaihistov:docs/add-robots-txt

Conversation

@solid-illiaaihistov

@solid-illiaaihistov solid-illiaaihistov commented Sep 10, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Updated package and website links to https://lints.solid.software.
    • Added a plain-text overview with setup guidance, lint rules, and related packages.
    • Enabled site crawling and listed the sitemap location.
    • Added titles, descriptions, and keywords to documentation pages and generated rule pages.
    • Added concise descriptions and consistent metadata to generated rule documentation.
    • Added Solid Software maintainer information and links to related resources.
    • Added structured site metadata and links for search and sharing previews.

@coderabbitai

coderabbitai Bot commented Sep 10, 2026

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: b26c0902-2bab-45bc-b935-2e6b0c27edf7

📥 Commits

Reviewing files that changed from the base of the PR and between ab9259a and 3e910ae.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The documentation generator adds Docusaurus frontmatter from rule descriptions. Site and package metadata now point to https://lints.solid.software. The site adds crawler directives, structured metadata, maintainer links, and an LLM-readable package overview.

Changes

Documentation and metadata

Layer / File(s) Summary
Generated rule documentation
lib/src/utils/docs_parser/..., test/src/utils/docs_parser/...
Generated rule pages now include frontmatter with extracted descriptions and keywords. Tests cover fallback text, sentence extraction, Markdown boundaries, and backtick removal.
Site metadata and discovery
doc/docusaurus/...
The site adds structured metadata, page frontmatter, navigation links, crawler directives, a sitemap reference, and an LLM-readable package overview.
Package and maintainer information
pubspec.yaml, doc/docusaurus/package.json, README.md
Package links use the new site. The README identifies Solid Software as the maintainer and includes related links.
Rule documentation cleanup
lib/src/lints/*/*_rule.dart
Several rule documentation comments have heading text removed or terminal punctuation added.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~12 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 3e910

No merge-blocking issue is established by the supplied change context.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (1 skipped: 1 … Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately identifies the main documentation changes: adding robots.txt and llms.txt files and updating documentation URLs. It is concise and specific enough for the changeset.
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.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (1 skipped: 1 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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.

This branch has not been deployed

No deployments
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