Skip to content

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

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

solid-illiaaihistov wants to merge 9 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 use https://lints.solid.software.
    • Added a plain-text overview of the lint package, including setup guidance, available rules, and related packages.
    • Enabled search engine crawling and added the site sitemap location.
    • Added page metadata to improve discoverability and search results.
    • Improved generated rule documentation with concise descriptions and consistent formatting.
    • Added Solid Software maintainer information and related resource links.

@coderabbitai

coderabbitai Bot commented Sep 10, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: e05deabf-9472-4bda-93a1-5a422e01d8b1

📥 Commits

Reviewing files that changed from the base of the PR and between 447f679 and a54684e.

📒 Files selected for processing (17)
  • README.md
  • doc/docusaurus/docs/1_rulesets/main.md
  • doc/docusaurus/docs/1_rulesets/test.md
  • doc/docusaurus/docs/3_other_notable_packages.md
  • doc/docusaurus/docusaurus.config.js
  • doc/docusaurus/src/pages/index.tsx
  • doc/docusaurus/static/llms.txt
  • lib/src/lints/avoid_late_keyword/avoid_late_keyword_rule.dart
  • lib/src/lints/avoid_similar_names/avoid_similar_names_rule.dart
  • lib/src/lints/avoid_unrelated_type_assertions/avoid_unrelated_type_assertions_rule.dart
  • lib/src/lints/newline_before_return/newline_before_return_rule.dart
  • lib/src/lints/no_magic_number/no_magic_number_rule.dart
  • lib/src/lints/prefer_conditional_expressions/prefer_conditional_expressions_rule.dart
  • lib/src/utils/docs_parser/output_formatters/docusaurus_formatter.dart
  • lib/src/utils/docs_parser/utils/rule_description_extractor.dart
  • pubspec.yaml
  • test/src/utils/docs_parser/utils/rule_description_extractor_test.dart
💤 Files with no reviewable changes (2)
  • lib/src/lints/avoid_late_keyword/avoid_late_keyword_rule.dart
  • lib/src/lints/avoid_similar_names/avoid_similar_names_rule.dart
🚧 Files skipped from review as they are similar to previous changes (2)
  • pubspec.yaml
  • doc/docusaurus/static/llms.txt

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


📝 Walkthrough

Walkthrough

The documentation pipeline now generates Docusaurus frontmatter from rule descriptions. Site and package metadata 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 documentation metadata
lib/src/utils/docs_parser/..., test/src/utils/docs_parser/...
Generated rule pages now include frontmatter with extracted descriptions and keywords. Tests cover fallback, 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 metadata
pubspec.yaml, README.md
Package links now use the new site. The README identifies Solid Software as the maintainer and adds related links.
Rule documentation cleanup
lib/src/lints/*/*_rule.dart
Several rule documentation comments now use consistent headings or terminal punctuation.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to a5468

The documentation and metadata changes have no identified merge-blocking issue.

🚥 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. (13 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.
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. (13 skipped: 13 unsupported.)

  • Fix all pre-merge checks with AI
✨ 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.

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