DOC: Fix cut passages from README in documentation index file
#258
Conversation
Fix cut passages from `README` in documentation index file: remove the `start-line` and `end-line` directives and include the `README` file entirely. The `start-line` and `end-line` directives were making such that relevant passages of the `README` file providing context for the tool were not being included. Thus the text shown in the documentation index file had some missing parts, and was not making sense. Do not include the `eddymotion-flowchart.svg` figure: it is already contained in the `README` file.
|
@effigies tagging you here, as I've seen this commit: I see that it was intended to avoid showing the picture in the Are you OK including the entire Edit: This is what the current documentation index looks like and what this patch set intends to fix: 
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #258 +/- ##
=======================================
Coverage 66.24% 66.24%
=======================================
Files 19 19
Lines 942 942
Branches 119 119
=======================================
Hits 624 624
Misses 274 274
Partials 44 44 ☔ View full report in Codecov by Sentry. |
Fix cut passages from
READMEin documentation index file: remove thestart-lineandend-linedirectives and include theREADMEfile entirely.The
start-lineandend-linedirectives were making such that relevant passages of theREADMEfile providing context for the tool were not being included. Thus the text shown in the documentation index file had some missing parts, and was not making sense.Do not include the
eddymotion-flowchart.svgfigure: it is already contained in theREADMEfile.