GoogleCloudPlatform / GoogleCloudPlatform/open-knowledge-format

Specify subdirectory topic lead concepts

Open Beginner friendly
#10 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
467
Forks
35
Avg merge
9m
Merged PRs (30d)
1

Description

Inspired by https://github.com/enola-dev/wiki/commit/ccfd3f62d10c1b2605905b99d8c091fbd6d52a6a,

would it perhaps make sense to have the Spec spell out something along the lines of:

> If a directory contains a concept document named identically to the directory itself (e.g., `memory/memory.md`), it serves as the overarching topic concept. In auto-generated `index.md`, it is placed as the preamble immediately under the `# ` heading and omitted from `## Articles`.

Would a PR with a suggesting initial wording for this be welcome?

Contributor guide

Open the contributing guide

Research direction

Start by reading the Spec and the referenced example commit, then inspect how a directory-named concept such as memory/memory.md relates to the generated index.md. Update the Spec with initial wording that defines the preamble placement under the category heading and exclusion from Articles; done means the behavior is unambiguous for implementers.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.