Skip to content

R eslava.result flow#459

Merged
ignatandrei merged 4 commits intomainfrom
REslava.ResultFlow
Mar 8, 2026
Merged

R eslava.result flow#459
ignatandrei merged 4 commits intomainfrom
REslava.ResultFlow

Conversation

@ignatandrei
Copy link
Copy Markdown
Owner

@ignatandrei ignatandrei commented Mar 8, 2026

Summary by CodeRabbit

  • New Features
    • Added REslava.ResultFlow, the 258th Roslyn Source Code Generator example, which generates Mermaid pipeline diagrams at compile time for Result libraries. Includes complete documentation with code examples, configuration files, HTML pages, author information, and code tours. Updated all reference indices and category listings to reflect the new entry.

Copilot AI review requested due to automatic review settings March 8, 2026 16:52
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 8, 2026

📝 Walkthrough

Walkthrough

This pull request adds REslava.ResultFlow as the 258th RSCG example, which generates Mermaid pipeline diagrams at compile time. Updates include adding the Documentation category enum value, updating all documentation and metadata files to reflect the new count, creating the example project with source files, and adding tour and configuration files.

Changes

Cohort / File(s) Summary
Documentation & Count Bumps
README.md, later.md, v2/rscg_examples_site/docs/about.md, v2/rscg_examples_site/src/components/HomepageFeatures/index.js
Updated all references from 257 to 258 examples and latest timestamp from 2026-02-15 to 2026-03-18.
Category Enum & Metadata
v2/GeneratorData/Category.cs, v2/RSCGExamplesData/GeneratorDataRec.json
Added Documentation=46 enum member to Category; added new JSON entry for REslava.ResultFlow with category 46 and generated date 2026-03-18.
Generator Logic Updates
v2/Generator/MultiGeneratorV2.cs
Added four string replacements in GrabReadMe and SourceNoRSCG processing: replacing {reasonPhrase}, {code}, and contributor reference patterns with formatted versions.
HTML Book & Navigation
v2/book/examples/REslava.ResultFlow.html, v2/book/list.html, v2/book/pandocHTML.yaml
Added new HTML documentation page for REslava.ResultFlow (258), updated list to include new entry, and modified pandocHTML build config to reference new example.
Example Project Files
v2/rscg_examples/REslava.ResultFlow/src/...
Created complete example project including ReslavaResultFlow.slnx, ResultFlowGenerator.csproj, Program.cs, Helpers.cs, description.json, nuget.txt, and video.json tour script.
Code Tour Configuration
v2/.tours/REslava.ResultFlow.tour
Added new CodeTour file defining steps through the REslava.ResultFlow example project files (csproj, Helpers.cs, Program.cs, and generated files).
Site Documentation Pages
v2/rscg_examples_site/docs/Authors/Rafa_Eslava.md, v2/rscg_examples_site/docs/Categories/Documentation.md, v2/rscg_examples_site/docs/Categories/_PrimitiveDocumentation.mdx
Added author profile page for Rafa Eslava, created new Documentation category page, and added category documentation snippet.
Site Index & Exports
v2/rscg_examples_site/docs/RSCG-Examples/index.md, v2/rscg_examples_site/docs/indexRSCG.md, v2/rscg_examples_site/static/exports/RSCG.json
Updated RSCG list pages from 257 to 258 count, added Documentation section with new entry, and appended REslava.ResultFlow to exports JSON with metadata.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

Possibly related PRs

  • first version #444: Adds Idempotency=45 enum member to the same Category.cs file; both PRs extend the enum with a new category.
  • ConsoleAppFramework #407: Modifies MultiGeneratorV2.cs to add string-replacement rules in README/documentation processing paths; similar pattern of extending text substitutions.
  • Add XmlCommentGenerator example and documentation #429: Adds a complete new RSCG example and modifies MultiGeneratorV2.cs string replacements alongside GeneratorDataRec.json updates; same overall integration pattern.

Poem

🐰 A new flow takes shape, diagrams in sight,
Result pipes drawn by generators' might,
Documentation flows where data once was dense,
Two hundred fifty-eight examples make sense,
REslava's gift of blueprints, rendered bright!

🚥 Pre-merge checks | ✅ 2 | ❌ 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%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'R eslava.result flow' directly references the main change in the changeset—adding the 258th RSCG example for REslava.ResultFlow generator.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch REslava.ResultFlow

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 and usage tips.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a new Roslyn Source Code Generator example entry for REslava.ResultFlow across the repo’s data sources, generated documentation site, and book exports, including introducing a new Documentation category.

Changes:

  • Add a new v2/rscg_examples/REslava.ResultFlow sample project and accompanying metadata (description, NuGet blurb, video script, tour).
  • Update exported lists (JSON/Excel), docs indices, and book HTML/pandoc inputs to include example #258.
  • Extend generator/category infrastructure to include the new Documentation category and adjust README/readme-processing.

Reviewed changes

Copilot reviewed 25 out of 29 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
v2/rscg_examples_site/static/sources/REslava.ResultFlow.zip Adds downloadable source archive for the new example.
v2/rscg_examples_site/static/exports/RSCG.xlsx Updates Excel export to include the new generator entry.
v2/rscg_examples_site/static/exports/RSCG.json Adds REslava.ResultFlow entry to the JSON export list.
v2/rscg_examples_site/src/components/HomepageFeatures/index.js Updates homepage example count from 257 to 258.
v2/rscg_examples_site/docs/indexRSCG.md Updates list header/count and adds row for generator #258.
v2/rscg_examples_site/docs/about.md Updates the overall example count to 258.
v2/rscg_examples_site/docs/RSCG-Examples/index.md Adds Documentation category section and adds mermaid edge for REslava.ResultFlow.
v2/rscg_examples_site/docs/Categories/_PrimitiveDocumentation.mdx Adds primitive include listing generators in Documentation category.
v2/rscg_examples_site/docs/Categories/Documentation.md Adds the Documentation category page content.
v2/rscg_examples_site/docs/Authors/Rafa_Eslava.md Adds author page for Rafa Eslava.
v2/rscg_examples/REslava.ResultFlow/video.json Adds video automation steps for the example.
v2/rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/ResultFlowGenerator.csproj Adds the sample project and NuGet references for REslava.Result/ResultFlow.
v2/rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/Program.cs Adds a simple console runner that prints the generated flow and runs the sample.
v2/rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/Helpers.cs Adds a fluent Result pipeline annotated with [ResultFlow] for diagram generation.
v2/rscg_examples/REslava.ResultFlow/src/ReslavaResultFlow.slnx Adds a minimal solution file referencing the sample project.
v2/rscg_examples/REslava.ResultFlow/readme.txt Adds upstream README content used by the documentation pipeline.
v2/rscg_examples/REslava.ResultFlow/nuget.txt Adds short NuGet/package description blurb.
v2/rscg_examples/REslava.ResultFlow/description.json Adds generator metadata consumed by the site/docs generator.
v2/book/pandocHTML.yaml Adds the new example HTML page to the pandoc build inputs.
v2/book/list.html Updates the book list count and adds link to example #258.
v2/book/examples/REslava.ResultFlow.html Adds the generated book page for the new example.
v2/RSCGExamplesData/GeneratorDataRec.json Adds generator record for REslava.ResultFlow with category/date metadata.
v2/GeneratorData/Category.cs Adds Documentation as a new category enum value.
v2/Generator/all.csv Adds generator #258 row to the CSV list.
v2/Generator/MultiGeneratorV2.cs Adds readme text replacements related to braces placeholders and links.
v2/.tours/REslava.ResultFlow.tour Adds a VS Code CodeTour for the new example.
later.md Updates “Latest Update” date for the repo.
README.md Updates total count to 258, latest update date, and adds entry #258.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +157 to +158
text = text.Replace("{reasonPhrase}", "`{reasonPhrase`}");
text = text.Replace("{code}", "`{code`}");
Copy link

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The replacement strings here look malformed: wrapping {reasonPhrase} / {code} in backticks is likely intended to prevent MDX interpolation, but the current replacements produce an unmatched backtick pattern and leave a trailing } outside the code span. This can result in broken markdown/MDX output. Consider replacing with a properly balanced inline-code form (e.g., backticks around the entire token including both braces) or escaping braces in a way compatible with MDX.

Suggested change
text = text.Replace("{reasonPhrase}", "`{reasonPhrase`}");
text = text.Replace("{code}", "`{code`}");
text = text.Replace("{reasonPhrase}", "`{reasonPhrase}`");
text = text.Replace("{code}", "`{code}`");

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 6

🧹 Nitpick comments (1)
v2/rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/ResultFlowGenerator.csproj (1)

16-19: Inconsistent indentation detected.

Lines 16-19 use tabs while the rest of the file uses spaces for indentation. Consider normalizing to maintain consistency.

📝 Proposed fix for consistent indentation
-	<PackageReference Include="REslava.ResultFlow" Version="1.36.0">
-		<PrivateAssets>all</PrivateAssets>
-		<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-	</PackageReference>
+    <PackageReference Include="REslava.ResultFlow" Version="1.36.0">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@v2/rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/ResultFlowGenerator.csproj`
around lines 16 - 19, The PackageReference block for "REslava.ResultFlow" in the
ResultFlowGenerator.csproj uses tabs for indentation while the rest of the
csproj uses spaces; update that block (the <PackageReference
Include="REslava.ResultFlow" Version="1.36.0"> ... </PackageReference> element)
to use the same space-based indentation style as the file (replace tabs with
spaces) so the file's indentation is consistent.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 7: The README's metadata header "## Latest Update : 2026-03-18 => 18
March 2026" (and any other generated date entries such as the "generated date"
field) is set to a future date; update these to the PR/open date (2026-03-08) or
to use a dynamic generation method that inserts the current date at build time.
Locate the string "## Latest Update : 2026-03-18 => 18 March 2026" in README.md
(and the analogous "generated date" entry mentioned) and change the hard-coded
date to "2026-03-08" or wire it to your date generator so docs are never stamped
with a future date.

In `@v2/.tours/REslava.ResultFlow.tour`:
- Around line 26-36: The tour entries list generated files with inverted
numbering; update the two JSON entries in REslava.ResultFlow.tour that contain
"description": "Generated File 2  from 2 : ResultFlowAttribute.g.cs " and
"description": "Generated File 1  from 2 : Helpers_Flows.g.cs " so the
descriptions reflect natural order (i.e., "Generated File 1 from 2" for the
first listed file and "Generated File 2 from 2" for the second), or
alternatively swap the two objects so the file with Helpers_Flows.g.cs is listed
first; edit the description strings or object order accordingly to ensure
numbering is sequential and not backwards.

In `@v2/rscg_examples_site/docs/Categories/Documentation.md`:
- Line 5: The category entry starting with the markdown link
"[REslava.ResultFlow]" is indented with eight leading spaces which turns it into
a code block; remove those leading spaces so the line begins with the link/badge
text (so the Markdown link and badge syntax render normally) and ensure the
entry is left-aligned with other list items in the document.

In `@v2/rscg_examples_site/docs/indexRSCG.md`:
- Line 23: The markdown link text "[REslava.ResultFlow by Rafa Eslava ]"
contains an extra space before the closing bracket which triggers MD039; remove
that trailing space so the link becomes "[REslava.ResultFlow by Rafa Eslava]"
(and scan for any other occurrences of the same pattern) to fix the lint error.

In `@v2/rscg_examples_site/static/exports/RSCG.json`:
- Around line 2061-2067: The "REslava.ResultFlow" entry has a future AddedOn
date; update the "AddedOn" value in the JSON object for Name
"REslava.ResultFlow" (the AddedOn field) to a non-future date — e.g., the
PR/actual publish date "2026-03-08" — or remove this entry from the export until
2026-03-18 so the catalog order remains correct.

In `@v2/rscg_examples/REslava.ResultFlow/video.json`:
- Around line 35-38: The JSON array contains invalid syntax: move the SpeakTest
property into the same object as the browser step (i.e., add SpeakTest as a key
inside the object that contains "typeStep":"browser" and
"arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/REslava.ResultFlow#download-example-net--c-")
so it becomes a valid property of that step, and remove the trailing comma after
the final array element to ensure the JSON array is syntactically valid.

---

Nitpick comments:
In
`@v2/rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/ResultFlowGenerator.csproj`:
- Around line 16-19: The PackageReference block for "REslava.ResultFlow" in the
ResultFlowGenerator.csproj uses tabs for indentation while the rest of the
csproj uses spaces; update that block (the <PackageReference
Include="REslava.ResultFlow" Version="1.36.0"> ... </PackageReference> element)
to use the same space-based indentation style as the file (replace tabs with
spaces) so the file's indentation is consistent.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5dd1d044-e357-4f94-84af-e9a14bbe3da0

📥 Commits

Reviewing files that changed from the base of the PR and between 6ad4dc0 and e202220.

⛔ Files ignored due to path filters (3)
  • v2/Generator/all.csv is excluded by !**/*.csv
  • v2/rscg_examples_site/static/exports/RSCG.xlsx is excluded by !**/*.xlsx
  • v2/rscg_examples_site/static/sources/REslava.ResultFlow.zip is excluded by !**/*.zip
📒 Files selected for processing (26)
  • README.md
  • later.md
  • v2/.tours/REslava.ResultFlow.tour
  • v2/Generator/MultiGeneratorV2.cs
  • v2/GeneratorData/Category.cs
  • v2/RSCGExamplesData/GeneratorDataRec.json
  • v2/book/examples/REslava.ResultFlow.html
  • v2/book/list.html
  • v2/book/pandocHTML.yaml
  • v2/rscg_examples/REslava.ResultFlow/description.json
  • v2/rscg_examples/REslava.ResultFlow/nuget.txt
  • v2/rscg_examples/REslava.ResultFlow/readme.txt
  • v2/rscg_examples/REslava.ResultFlow/src/ReslavaResultFlow.slnx
  • v2/rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/Helpers.cs
  • v2/rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/Program.cs
  • v2/rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/ResultFlowGenerator.csproj
  • v2/rscg_examples/REslava.ResultFlow/video.json
  • v2/rscg_examples_site/docs/Authors/Rafa_Eslava.md
  • v2/rscg_examples_site/docs/Categories/Documentation.md
  • v2/rscg_examples_site/docs/Categories/_PrimitiveDocumentation.mdx
  • v2/rscg_examples_site/docs/RSCG-Examples/REslava.ResultFlow.md
  • v2/rscg_examples_site/docs/RSCG-Examples/index.md
  • v2/rscg_examples_site/docs/about.md
  • v2/rscg_examples_site/docs/indexRSCG.md
  • v2/rscg_examples_site/src/components/HomepageFeatures/index.js
  • v2/rscg_examples_site/static/exports/RSCG.json

This system serves as both a learning resource for .NET developers interested in source generators and an automated pipeline for maintaining up-to-date documentation about the RSCG ecosystem

## Latest Update : 2026-02-15 => 15 February 2026
## Latest Update : 2026-03-18 => 18 March 2026
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix the future-dated metadata.

These entries say the latest update and generated date are March 18, 2026, but this PR was opened on March 8, 2026. Shipping docs with future dates will make the catalog look incorrect for ten days and usually means the generation date source is off.

Also applies to: 31-31

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 7, The README's metadata header "## Latest Update :
2026-03-18 => 18 March 2026" (and any other generated date entries such as the
"generated date" field) is set to a future date; update these to the PR/open
date (2026-03-08) or to use a dynamic generation method that inserts the current
date at build time. Locate the string "## Latest Update : 2026-03-18 => 18 March
2026" in README.md (and the analogous "generated date" entry mentioned) and
change the hard-coded date to "2026-03-08" or wire it to your date generator so
docs are never stamped with a future date.

Comment on lines +26 to +36
,{
"file": "rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/obj/GX/REslava.ResultFlow/REslava.ResultFlow.Generators.ResultFlow.ResultFlowGenerator/ResultFlowAttribute.g.cs",
"description": "Generated File 2 from 2 : ResultFlowAttribute.g.cs ",
"line": 1
}

,{
"file": "rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/obj/GX/REslava.ResultFlow/REslava.ResultFlow.Generators.ResultFlow.ResultFlowGenerator/Helpers_Flows.g.cs",
"description": "Generated File 1 from 2 : Helpers_Flows.g.cs ",
"line": 1
}
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Generated file descriptions are numbered backwards.

The step descriptions show "Generated File 2 from 2" (line 28) before "Generated File 1 from 2" (line 34), which is confusing. Consider swapping the numbering to reflect the natural order.

📝 Proposed fix
         ,{
         "file": "rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/obj/GX/REslava.ResultFlow/REslava.ResultFlow.Generators.ResultFlow.ResultFlowGenerator/ResultFlowAttribute.g.cs",
-        "description": "Generated File 2  from 2 : ResultFlowAttribute.g.cs ",
+        "description": "Generated File 1 from 2 : ResultFlowAttribute.g.cs ",
         "line": 1
         }
     
         ,{
         "file": "rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/obj/GX/REslava.ResultFlow/REslava.ResultFlow.Generators.ResultFlow.ResultFlowGenerator/Helpers_Flows.g.cs",
-        "description": "Generated File 1  from 2 : Helpers_Flows.g.cs ",
+        "description": "Generated File 2 from 2 : Helpers_Flows.g.cs ",
         "line": 1
         }
📝 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.

Suggested change
,{
"file": "rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/obj/GX/REslava.ResultFlow/REslava.ResultFlow.Generators.ResultFlow.ResultFlowGenerator/ResultFlowAttribute.g.cs",
"description": "Generated File 2 from 2 : ResultFlowAttribute.g.cs ",
"line": 1
}
,{
"file": "rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/obj/GX/REslava.ResultFlow/REslava.ResultFlow.Generators.ResultFlow.ResultFlowGenerator/Helpers_Flows.g.cs",
"description": "Generated File 1 from 2 : Helpers_Flows.g.cs ",
"line": 1
}
,{
"file": "rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/obj/GX/REslava.ResultFlow/REslava.ResultFlow.Generators.ResultFlow.ResultFlowGenerator/ResultFlowAttribute.g.cs",
"description": "Generated File 1 from 2 : ResultFlowAttribute.g.cs ",
"line": 1
}
,{
"file": "rscg_examples/REslava.ResultFlow/src/ResultFlowGenerator/obj/GX/REslava.ResultFlow/REslava.ResultFlow.Generators.ResultFlow.ResultFlowGenerator/Helpers_Flows.g.cs",
"description": "Generated File 2 from 2 : Helpers_Flows.g.cs ",
"line": 1
}
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@v2/.tours/REslava.ResultFlow.tour` around lines 26 - 36, The tour entries
list generated files with inverted numbering; update the two JSON entries in
REslava.ResultFlow.tour that contain "description": "Generated File 2  from 2 :
ResultFlowAttribute.g.cs " and "description": "Generated File 1  from 2 :
Helpers_Flows.g.cs " so the descriptions reflect natural order (i.e., "Generated
File 1 from 2" for the first listed file and "Generated File 2 from 2" for the
second), or alternatively swap the two objects so the file with
Helpers_Flows.g.cs is listed first; edit the description strings or object order
accordingly to ensure numbering is sequential and not backwards.


Number RSCG: 1

1 [REslava.ResultFlow](/docs/REslava.ResultFlow) [![Nuget](https://img.shields.io/nuget/dt/REslava.ResultFlow?label=REslava.ResultFlow)](https://www.nuget.org/packages/REslava.ResultFlow/) ![GitHub Repo stars](https://img.shields.io/github/stars/reslava/nuget-package-reslava-result?style=social) 2026-03-18
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion | 🟠 Major

Remove the indentation from the category entry.

The eight leading spaces on Line 5 make this an indented code block, so the Markdown link and badge syntax won't render on the page. (spec.commonmark.org)

Proposed fix
-        1 [REslava.ResultFlow](/docs/REslava.ResultFlow) [![Nuget](https://img.shields.io/nuget/dt/REslava.ResultFlow?label=REslava.ResultFlow)](https://www.nuget.org/packages/REslava.ResultFlow/) ![GitHub Repo stars](https://img.shields.io/github/stars/reslava/nuget-package-reslava-result?style=social) 2026-03-18
+1. [REslava.ResultFlow](/docs/REslava.ResultFlow) [![Nuget](https://img.shields.io/nuget/dt/REslava.ResultFlow?label=REslava.ResultFlow)](https://www.nuget.org/packages/REslava.ResultFlow/) ![GitHub Repo stars](https://img.shields.io/github/stars/reslava/nuget-package-reslava-result?style=social) 2026-03-18
📝 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.

Suggested change
1 [REslava.ResultFlow](/docs/REslava.ResultFlow) [![Nuget](https://img.shields.io/nuget/dt/REslava.ResultFlow?label=REslava.ResultFlow)](https://www.nuget.org/packages/REslava.ResultFlow/) ![GitHub Repo stars](https://img.shields.io/github/stars/reslava/nuget-package-reslava-result?style=social) 2026-03-18
1. [REslava.ResultFlow](/docs/REslava.ResultFlow) [![Nuget](https://img.shields.io/nuget/dt/REslava.ResultFlow?label=REslava.ResultFlow)](https://www.nuget.org/packages/REslava.ResultFlow/) ![GitHub Repo stars](https://img.shields.io/github/stars/reslava/nuget-package-reslava-result?style=social) 2026-03-18
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@v2/rscg_examples_site/docs/Categories/Documentation.md` at line 5, The
category entry starting with the markdown link "[REslava.ResultFlow]" is
indented with eight leading spaces which turns it into a code block; remove
those leading spaces so the line begins with the link/badge text (so the
Markdown link and badge syntax render normally) and ensure the entry is
left-aligned with other list items in the document.


| No | Name | Date | Category |
| --------- | ----- | ---- | -------- |
|258| [REslava.ResultFlow by Rafa Eslava ](/docs/REslava.ResultFlow)|2026-03-18 => 18 March 2026 | [Documentation](/docs/Categories/Documentation) |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Remove the extra space inside the new link text.

Line 23 uses [REslava.ResultFlow by Rafa Eslava ], which triggers MD039 and can break the markdown lint step.

Suggested fix
-|258| [REslava.ResultFlow by Rafa Eslava ](/docs/REslava.ResultFlow)|2026-03-18 => 18 March 2026 | [Documentation](/docs/Categories/Documentation) |
+|258| [REslava.ResultFlow by Rafa Eslava](/docs/REslava.ResultFlow)|2026-03-18 => 18 March 2026 | [Documentation](/docs/Categories/Documentation) |
📝 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.

Suggested change
|258| [REslava.ResultFlow by Rafa Eslava ](/docs/REslava.ResultFlow)|2026-03-18 => 18 March 2026 | [Documentation](/docs/Categories/Documentation) |
|258| [REslava.ResultFlow by Rafa Eslava](/docs/REslava.ResultFlow)|2026-03-18 => 18 March 2026 | [Documentation](/docs/Categories/Documentation) |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 23-23: Spaces inside link text

(MD039, no-space-in-links)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@v2/rscg_examples_site/docs/indexRSCG.md` at line 23, The markdown link text
"[REslava.ResultFlow by Rafa Eslava ]" contains an extra space before the
closing bracket which triggers MD039; remove that trailing space so the link
becomes "[REslava.ResultFlow by Rafa Eslava]" (and scan for any other
occurrences of the same pattern) to fix the lint error.

Comment on lines +2061 to +2067
{
"Name": "REslava.ResultFlow",
"Link": "https://ignatandrei.github.io/RSCG_Examples/v2/docs/REslava.ResultFlow",
"NuGet": "https://www.nuget.org/packages/REslava.ResultFlow/",
"Source": "https://github.com/reslava/nuget-package-reslava-result/",
"Category": "Documentation",
"AddedOn": "2026-03-18T00:00:00"
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Avoid future-dating the new catalog entry.

Line 2067 sets AddedOn to March 18, 2026, but this PR was opened on March 8, 2026. Anything consuming this export as a chronological source will surface REslava.ResultFlow as newer than every current example for the next 10 days. Please use the actual publish date here, or keep the entry out of the export until March 18.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@v2/rscg_examples_site/static/exports/RSCG.json` around lines 2061 - 2067, The
"REslava.ResultFlow" entry has a future AddedOn date; update the "AddedOn" value
in the JSON object for Name "REslava.ResultFlow" (the AddedOn field) to a
non-future date — e.g., the PR/actual publish date "2026-03-08" — or remove this
entry from the export until 2026-03-18 so the catalog order remains correct.

Comment on lines +35 to +38
{"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/REslava.ResultFlow#download-example-net--c-",
SpeakTest=" "},
{"typeStep":"waitseconds","arg":"30"},
]
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Invalid JSON syntax will cause parsing failures.

There are two JSON syntax issues:

  1. Line 36: SpeakTest=" " appears to be intended as a property but is placed after the closing brace of the object on line 35.
  2. Line 38: Trailing comma after the last array element is invalid JSON.
🐛 Proposed fix
-{"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/REslava.ResultFlow#download-example-net--c-",
-SpeakTest=" "},
-{"typeStep":"waitseconds","arg":"30"},
+{"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/REslava.ResultFlow#download-example-net--c-",
+"SpeakTest":" "},
+{"typeStep":"waitseconds","arg":"30"}
 ]
📝 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.

Suggested change
{"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/REslava.ResultFlow#download-example-net--c-",
SpeakTest=" "},
{"typeStep":"waitseconds","arg":"30"},
]
{"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/REslava.ResultFlow#download-example-net--c-",
"SpeakTest":" "},
{"typeStep":"waitseconds","arg":"30"}
]
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@v2/rscg_examples/REslava.ResultFlow/video.json` around lines 35 - 38, The
JSON array contains invalid syntax: move the SpeakTest property into the same
object as the browser step (i.e., add SpeakTest as a key inside the object that
contains "typeStep":"browser" and
"arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/REslava.ResultFlow#download-example-net--c-")
so it becomes a valid property of that step, and remove the trailing comma after
the final array element to ensure the JSON array is syntactically valid.

@ignatandrei ignatandrei merged commit c2c9a73 into main Mar 8, 2026
7 checks passed
@ignatandrei ignatandrei deleted the REslava.ResultFlow branch March 8, 2026 17:02
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.

2 participants