Index regeneration replaces hand-written subdirectory descriptions with a Contains N fallback

Open
#261 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
csharp, markdown
Domain
tooling

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

.NET question

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

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jchable/okf4net

All issues in jchable/okf4net

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.