Index regeneration replaces hand-written subdirectory descriptions with a Contains N fallback
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
Research direction
Start with IndexGenerator.cs:88 in src/OKF4net and read the index generation rules in §8. Decide how regeneration should preserve subdirectory descriptions, provide a description source, or document the current behavior before changing code. Check the existing goldens; done means the chosen behavior is implemented or documented and the goldens reflect it.
Written by the indexing model from the issue text.
Description
Area
src/OKF4net — IndexGenerator (fallback at IndexGenerator.cs:88).
Question
Regenerating indexes replaces a subdirectory description written in the parent index.md (e.g. by upstream's generator in bundles/ga4, for references/ and references/metrics/) with the fallback Contains N: …. A directory has no frontmatter of its own, so the existing index is the only place that description lives, and regeneration loses it. §8 lets producers generate index.md but says nothing on keeping hand-written directory descriptions.
Options: carry over an existing entry's description for a subdirectory, a per-directory description source, or keep the current behaviour and document it. Decide before changing (goldens likely move).
Found while writing the #159 sample.
- Dominant language
- C#
- Stars
- 4
- Forks
- 1
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 32
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from jchable/okf4net
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
.NET bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
test
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 Under an hour Newbie friendliness 82/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area/backend type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
umbraco/Umbraco-CMS#24668 · 1 comment ·
Maintainers usually reply within 1 day
-
Pri3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
MicrosoftDocs/windows-dev-docs#6205 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
area-ai untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
dotnet/extensions#7956 ·
Maintainers usually reply within 1 day