Feature/169 improve readibility of readme #193
Conversation
- Updated root README.md file. - Create new structure of features tutorials.
WalkthroughReplaces and streamlines README, adds a docs/ tree with configuration reference, motivation, and per-feature tutorial pages (extraction, custom chapters, duplicity, hierarchy, tag/date selection, skip labels, verbose mode, CodeRabbit integration, service chapters), plus examples. No code or public API changes. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor User as Workflow User
participant GA as GitHub Action Runner
participant RN as Release Notes Action
participant GH as GitHub API
participant CR as CodeRabbit
User->>GA: Trigger workflow (tag-name, config)
GA->>RN: Invoke action with inputs
RN->>GH: Resolve tag/date window and fetch issues/PRs/commits
alt Explicit Release Notes sections present
RN->>RN: Parse release-notes sections into bullets
else No explicit sections
opt coderabbit-support-active
RN->>CR: Request AI-derived summary blocks
CR-->>RN: Return summaries
RN->>RN: Convert summaries into bullet entries
end
end
RN->>RN: Apply skip labels, hierarchy, duplicity rules
RN->>RN: Populate custom chapters and service diagnostic chapters
RN-->>GA: Emit final Markdown release notes
GA-->>User: Publish notes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (3 warnings)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
README.md(1 hunks)docs/configuration_reference.md(1 hunks)docs/features/coderabbit_integration.md(1 hunks)docs/features/custom_chapters.md(1 hunks)docs/features/custom_row_formats.md(1 hunks)docs/features/date_selection.md(1 hunks)docs/features/duplicity_handling.md(1 hunks)docs/features/issue_hierarchy_support.md(1 hunks)docs/features/release_notes_extraction.md(1 hunks)docs/features/service_chapters.md(1 hunks)docs/features/skip_labels.md(1 hunks)docs/features/tag_range.md(1 hunks)docs/features/verbose_mode.md(1 hunks)docs/motivation.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/features/duplicity_handling.md
14-14: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
docs/motivation.md
13-13: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
36-36: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
README.md
25-25: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
171-171: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
- Added new output example to show hierarchy.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
127-133: Unify the referenced action version.Quick Start uses
@v1while the workflow example below pins@v1.0.0. Please pick one convention (ideally the maintained major tag) to avoid confusing readers or pushing them toward an outdated patch.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
README.md (1)
117-120: Previous concern resolved: input is now requiredThe workflow-dispatch input tag-name is marked required, preventing empty runs. Looks good.
🧹 Nitpick comments (3)
README.md (3)
104-104: Inconsistent guidance: tag must exist vs. “to be created”Line 104 states the tag must exist, while Lines 118–119 describe the tag as “to be created.” Clarify to avoid broken runs. Suggest updating the dispatch input description to reflect an existing tag requirement.
Apply this diff:
- tag-name: - description: 'Name of git tag to be created, and then draft release created. Syntax: "v[0-9]+.[0-9]+.[0-9]+".' + tag-name: + description: 'Existing git tag to use for this draft release. Syntax: "v[0-9]+.[0-9]+.[0-9]+". Ensure the tag is created and pushed before running.'Also applies to: 118-119
25-25: Fix markdownlint MD036: use proper headings, not emphasisConvert emphasized lines to headings for structure and lint compliance.
Apply this diff:
-**Key Benefits** +### Key Benefits-_Category legend (keep it consistent across docs)_ +### Category legend +Keep it consistent across docs.As per static analysis hints
Also applies to: 171-171
65-67: Typo in example output“Handfull copy operation has been developed.” → improve grammar.
Apply this diff:
- - Handfull copy operation has been developed. + - File copy operation has been implemented.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
25-25: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
171-171: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (2)
README.md (2)
1-1: Confirm branding: “Scrapper” vs “Scraper”If intentional, ensure consistency across repo, Marketplace listing, and badges; if not, consider “Scraper.”
Also applies to: 7-7
86-86: Verify runtime requirement claimDocs say “Python 3.11+.” Confirm the action actually requires/runs on 3.11+; adjust if broader (e.g., 3.10+).
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
171-178: Promote the category legend to a proper headingMarkdownlint flags the italicized line here (MD036). Making it a real heading keeps the navigation consistent and eliminates the lint warning.
-_Category legend (keep it consistent across docs)_ +#### Category legend (keep it consistent across docs)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
171-171: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
1 participant
Release Notes:
Summary by CodeRabbit
Fixes #169