Add press release and FAQ markdown docs #25
Conversation
WalkthroughAdds two new documentation files under Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 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
🧹 Nitpick comments (1)
docs/press-release.md (1)
15-15: Minor grammar refinement: hyphenate compound adjective.The phrase "batch deployable increments" uses a compound adjective that should be hyphenated for clarity per standard English grammar.
-- Repeatable work breakdown guides small batch deployable increments that keep feedback tight and progress visible. +- Repeatable work breakdown guides small batch-deployable increments that keep feedback tight and progress visible.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/faq.md(1 hunks)docs/press-release.md(1 hunks)
🧰 Additional context used
🪛 GitHub Actions: Run tests and linting
docs/faq.md
[error] 1-1: markdownlint-fix failed. MD001: Heading levels should only increment by one level at a time. The hook modified the file. Re-run pre-commit (pre-commit run --all-files) to verify and commit.
🪛 LanguageTool
docs/press-release.md
[grammar] ~15-~15: Use a hyphen to join words.
Context: ...- Repeatable work breakdown guides small batch deployable increments that keep fe...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.18.1)
docs/faq.md
3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
3-3: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
6-6: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
12-12: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
15-15: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
18-18: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
21-21: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
24-24: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
27-27: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
30-30: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
33-33: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
36-36: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
39-39: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
42-42: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🔇 Additional comments (1)
docs/press-release.md (1)
1-33: Content and structure look solid.The press release is well-organized with a clear problem statement (line 5), solution overview (line 9), and scaling guidance (line 25). The heading hierarchy is correct, supporting quotes add credibility, and the messaging is consistent with the FAQ. The document effectively communicates the key value propositions of the workflow.
|
@claude fix the ci failure |
|
Claude finished @ryderstorm's task —— View job Fixing CI Failure ✅Fixed the markdown linting errors that were causing the CI to fail. Todo List
Changes Made
SummaryAll markdown linting errors have been resolved. The changes have been committed and pushed to the Job Run: https://github.com/liatrio-labs/spec-driven-workflow/actions/runs/$RUN_ID | Branch: |
- Change all FAQ headings from h3 to h2 and add blank lines after headings - Fix hyphenation in press-release.md: "batch deployable" → "batch-deployable" This resolves MD001 and MD022 linting errors that were causing CI failures. Co-authored-by: Damien Storm <ryderstorm@users.noreply.github.com>
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 (2)
docs/faq.md(1 hunks)docs/press-release.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/faq.md
🔇 Additional comments (2)
docs/press-release.md (2)
1-33: Overall structure and messaging are strong.The press release is well-organized with a clear problem-solution narrative arc, concrete features, and scaling guidance. The tone is professional and appropriately pitched for stakeholder communication. No markdown syntax errors detected; formatting is consistent throughout.
1-33: Documentation files pass markdown validation; no issues found.The verification confirms that
docs/press-release.mdanddocs/faq.mdare valid:
- Markdownlint validation completed with zero errors
- Both files have proper heading hierarchy and structure
- No broken markdown links detected
- Markdown syntax is valid
If a CI failure exists, it is not caused by markdown content issues in these documentation files. Any CI failure would stem from other repository checks.
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
docs/press-release.md (1)
20-25: Remove or verify attributed quotes before publication.The quotes from Jordan Ramos (VectorScale) and Maya Chen (Skyline Robotics) could not be verified in the previous review and pose a credibility risk:
- Maya Chen at Skyline Robotics: No public evidence of this person holding this title at this company. Skyline Robotics' official site, LinkedIn, and press coverage do not list a Director of Product named Maya Chen.
- Jordan Ramos at VectorScale: VectorScale appears to be a dating/chat app company (Migo), not an AI-native development consultancy—attribution context is misaligned.
Publishing unverifiable or misattributed quotes damages organizational credibility, especially in a press release.
Either:
- Verify these individuals and document their approval for attribution, or
- Replace with generic testimonials (e.g., "A VP of Engineering at a high-growth AI company stated..."), or
- Remove the quotes entirely.
Engineering leaders already see impact: -> "Liatrio's Spec‑Driven Workflow cut our context switching in half," said Jordan Ramos, VP Engineering at VectorScale. "Specs, tickets, and agent prompts now live in the same backbone, and in our pilot quarter AI‑generated changes landed right the first time 40 percent more often." +> "Liatrio's Spec‑Driven Workflow cut our context switching in half," said a VP of Engineering at a high-growth AI company. "Specs, tickets, and agent prompts now live in the same backbone, and in our pilot quarter AI‑generated changes landed right the first time 40 percent more often." > -> "Product teams finally describe outcomes the same way engineering builds them," added Maya Chen, Director of Product at Skyline Robotics. "We now draft outcome specs in hours instead of days because the workflow keeps every ticket, prompt, and roadmap in sync." +> "Product teams finally describe outcomes the same way engineering builds them," added a Director of Product at a robotics company. "We now draft outcome specs in hours instead of days because the workflow keeps every ticket, prompt, and roadmap in sync."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/faq.md(1 hunks)docs/press-release.md(1 hunks)
🧰 Additional context used
🪛 GitHub Actions: Run tests and linting
docs/press-release.md
[error] 1-1: markdownlint-fix modified this file during pre-commit. Run 'pre-commit run --all-files' to fix formatting.
docs/faq.md
[error] 1-1: markdownlint-fix modified this file during pre-commit. Run 'pre-commit run --all-files' to fix formatting.
🪛 markdownlint-cli2 (0.18.1)
docs/press-release.md
2-2: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
docs/faq.md
2-2: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
🔇 Additional comments (2)
docs/faq.md (1)
4-58: LGTM—markdown structure is now correct.The FAQ sections are properly formatted with
##headings, blank lines after each heading, and clear answer text. The structure addresses the previous MD001 and MD022 issues flagged in the earlier review. Once the h1 heading spacing is fixed (above), the linting should pass.docs/press-release.md (1)
6-19: LGTM—core messaging and structure are clear.The problem statement, solution overview, and feature list clearly communicate the value of the Spec-Driven Workflow. The scaling examples (lines 28–34) effectively show deployment flexibility. Once the attribution issues are addressed and the markdown linting is fixed, this is publication-ready.
| > **Note:** This FAQ is a hypothetical example created for demonstration purposes. It illustrates how to document and answer common questions about the Spec-Driven Workflow and is included in this repository as sample documentation. | ||
| # Frequently Asked Questions |
There was a problem hiding this comment.
Add blank line between disclaimer and heading to fix markdown linting.
The h1 heading on line 2 lacks a blank line above it (after the disclaimer blockquote on line 1), triggering an MD022 linting violation and causing the pre-commit hook to fail. This is blocking the pipeline.
Apply this diff:
> **Note:** This FAQ is a hypothetical example created for demonstration purposes. It illustrates how to document and answer common questions about the Spec-Driven Workflow and is included in this repository as sample documentation.
+
# Frequently Asked Questions📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > **Note:** This FAQ is a hypothetical example created for demonstration purposes. It illustrates how to document and answer common questions about the Spec-Driven Workflow and is included in this repository as sample documentation. | |
| # Frequently Asked Questions | |
| > **Note:** This FAQ is a hypothetical example created for demonstration purposes. It illustrates how to document and answer common questions about the Spec-Driven Workflow and is included in this repository as sample documentation. | |
| # Frequently Asked Questions |
🧰 Tools
🪛 GitHub Actions: Run tests and linting
[error] 1-1: markdownlint-fix modified this file during pre-commit. Run 'pre-commit run --all-files' to fix formatting.
🪛 markdownlint-cli2 (0.18.1)
2-2: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
In docs/faq.md around lines 1 to 2, the H1 heading lacks a blank line after the
blockquote disclaimer which triggers an MD022 lint error; fix by inserting a
single blank line between the disclaimer line and the "# Frequently Asked
Questions" heading so the heading is separated from the blockquote.
| > **Note:** This press release is a hypothetical example created for demonstration purposes. It illustrates how to document and communicate the Spec-Driven Workflow and is included in this repository as sample documentation. | ||
| # Liatrio Launches Spec-Driven Workflow: A Codified, Versioned, Installable Framework for AI-Native Development |
There was a problem hiding this comment.
Add blank line between disclaimer and heading to fix markdown linting.
The h1 heading on line 2 lacks a blank line above it (after the disclaimer blockquote on line 1), triggering an MD022 linting violation and causing the pre-commit hook to fail.
Apply this diff:
> **Note:** This press release is a hypothetical example created for demonstration purposes. It illustrates how to document and communicate the Spec-Driven Workflow and is included in this repository as sample documentation.
+
# Liatrio Launches Spec-Driven Workflow: A Codified, Versioned, Installable Framework for AI-Native Development📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > **Note:** This press release is a hypothetical example created for demonstration purposes. It illustrates how to document and communicate the Spec-Driven Workflow and is included in this repository as sample documentation. | |
| # Liatrio Launches Spec-Driven Workflow: A Codified, Versioned, Installable Framework for AI-Native Development | |
| > **Note:** This press release is a hypothetical example created for demonstration purposes. It illustrates how to document and communicate the Spec-Driven Workflow and is included in this repository as sample documentation. | |
| # Liatrio Launches Spec-Driven Workflow: A Codified, Versioned, Installable Framework for AI-Native Development |
🧰 Tools
🪛 GitHub Actions: Run tests and linting
[error] 1-1: markdownlint-fix modified this file during pre-commit. Run 'pre-commit run --all-files' to fix formatting.
🪛 markdownlint-cli2 (0.18.1)
2-2: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
In docs/press-release.md around lines 1 to 2, the H1 heading is immediately
after the blockquote disclaimer which violates MD022; insert a single blank line
between the blockquote line and the heading so there is an empty line separating
the disclaimer and the "# Liatrio Launches..." heading to satisfy markdown
linting and the pre-commit hook.
This PR adds two new Markdown documents to the
docsdirectory:These files help communicate the purpose and usage of the Spec-Driven Workflow to teams and stakeholders.
Summary by CodeRabbit