Skip to content

docs(readme): link to kcenon-system-layout standard #629

Description

@kcenon

What

Add a link from logger_system's README files to the published kcenon-system-layout.md v1.0 standard, so contributors and consumers can navigate from the project entry point to the ecosystem-wide layout reference.

  • Current: Neither README.md nor README.kr.md references the layout standard. grep -i 'layout\|directory structure' returns no matches.
  • Expected: Both READMEs include a short "Project layout" section (or equivalent) with a hyperlink to kcenon-system-layout.md, noting that logger_system is a reference example for the ecosystem.
  • Scope: README content only. No code changes, no other doc files.

Why

  • The layout standard is only valuable if discoverable. Currently a contributor opening logger_system has no path to the ecosystem convention.
  • logger_system is being positioned as a reference example alongside pacs_system and common_system; the README is the natural place to make that role explicit.
  • Trivial change with high navigation value — closes a known gap in the EPIC [EPIC] logger_system: final standard verification #624 acceptance criteria.

Part of #624.

How

Technical Approach

  1. Add a "Project layout" (or equivalent) section near the top of README.md, with a short paragraph linking to kcenon-system-layout.md and noting that logger_system follows this standard.
  2. Mirror the change in README.kr.md (Korean translation).
  3. Keep the addition under ~5 lines per README; the layout doc itself holds the detail.
  4. Open a single PR titled docs(readme): link to kcenon-system-layout.md against develop. Author: kcenon <kcenon@naver.com> per repo convention.

Acceptance Criteria

  • README.md contains a hyperlink to the layout standard
  • README.kr.md contains the equivalent hyperlink
  • Both additions reference logger_system's role as a reference example (or a similar phrasing)
  • PR merged to develop via squash, branch deleted afterwards
  • No other README content modified beyond the new section

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationpriority:highHigh priority issue

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions