google-labs-code / google-labs-code/design.md

Recommended rules for DESIGN.md file discovery in registry

Open
#85 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
28k
Forks
2.3k
PR merge metrics
No merged PRs in 30d

Description

Hi @davideast

Following up on the earlier discussion #63 about whether a project should have one DESIGN.md file or multiple scoped DESIGN.md files..

We are working on designmd.sh, which we plan to launch today. It is a public registry and discovery layer for DESIGN.md files. For the registry, we need a practical starting point for finding DESIGN.md files in public GitHub repositories.

Since the spec does not currently define preferred file locations, we started with a small set of supported paths:

DESIGN.md (repo root)
docs/DESIGN.md
.agents/DESIGN.md
.cursor/DESIGN.md
.claude/DESIGN.md
design-system/DESIGN.md
design/DESIGN.md
design-md/DESIGN.md
website/DESIGN.md

And these nested collection-style paths:

design-md/<name>/DESIGN.md
designs/<name>/DESIGN.md
skills/<name>/DESIGN.md
.agents/skills/<name>/DESIGN.md
.claude/skills/<name>/DESIGN.md
.cursor/skills/<name>/DESIGN.md

We are currently using Google's DESIGN.md spec as the validation baseline. If a file follows the spec, we treat it as valid and show token previews in the registry. If it does not pass validation, we show the validation result.

Questions:
Do these locations seem reasonable for tools and registries?
What other locations should we consider and avoid?

Would love feedback from the Stitch team and the community

Contributor guide

Open the contributing guide

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.

Research direction

Start with the earlier discussion in issue #63 and the listed DESIGN.md discovery paths, then compare them with the Google DESIGN.md validation baseline. Done means the project has an agreed, documented recommendation for supported and excluded locations; no implementation file or test is identified in this issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, markdown
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.