molecule-ai/.github
35
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Org profile (README rendered on org page) + shared workflow templates
2 Commits 5 Branches 0 Tags 43 KiB
Markdown 100%
f0c13be92a
Go to file
claude-ceo-assistant (Claude Opus 4.7 on Hongming's MacBook) f0c13be92a docs(profile): add org-profile README + branding assets, document layout convention 
GitHub renders `<org>/.github/profile/README.md` as the org's public
landing page. Mirroring the same path here on Gitea so once GitHub
access is restored and repo-sync pushes this content over, it lands
in the right place automatically — no path translation step.

## Adds

- `profile/README.md` — comprehensive org-level intro (different from
  molecule-core's product-deep README): pitch in 1 paragraph, "what we
  ship" in 4 bullets, "where to start" routing table, repos-in-this-org
  index split by purpose (product / adapters / marketing), license +
  community footer.
- `profile/assets/molecule-icon.svg` — same SVG that landed on
  molecule-core's README in PR #5; light/dark adaptive via
  prefers-color-scheme styles.
- `profile/assets/molecule-logo.svg` — wordmark variant.

## Updates

- `README.md` (repo root, not user-visible on the org page) — documents
  the layout convention + lists the other cross-org defaults GitHub
  picks up from `<org>/.github/` (CONTRIBUTING.md, SECURITY.md,
  SUPPORT.md, issue/PR templates, workflow templates) so a future
  contributor knows where to add things.

## Why this content shape

GitHub org-profile READMEs are user-visible on the org's public page.
Standard wisdom for that surface:

- short — 1-2 screens, not the deep product pitch (which lives at
  molecule-core)
- routes the reader to the right repo for what they actually want
  (product / SaaS / Claude integration / docs / new runtime)
- lists the major repos with one-line descriptions so a visitor can
  navigate without 30 tabs
- names the license model (BSL 1.1 → Apache 2.0 on 2029-01-01)

The "Where to start" table is the load-bearing piece — the rest is
context. If a visitor only reads the table, they still know where to
go.

## Out of scope (parked)

- CONTRIBUTING.md, SECURITY.md, SUPPORT.md — would normally live here
  too. Skipping for now; current per-repo guidance is fine. File when
  the org has enough cross-cutting policy to warrant it.
- GitHub Actions workflow templates — not relevant while we're on
  Gitea + operator-host deploys.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
2026-05-06 17:10:56 -07:00
profile docs(profile): add org-profile README + branding assets, document layout convention 2026-05-06 17:10:56 -07:00
README.md docs(profile): add org-profile README + branding assets, document layout convention 2026-05-06 17:10:56 -07:00

README.md

Molecule-AI/.github

Org-level community files + the org-profile README rendered on the org page.

Layout

.github/
├── README.md            # this file (repo entry point, not user-visible on the org page)
└── profile/
    ├── README.md        # rendered on github.com/Molecule-AI when GitHub access is restored
    └── assets/
        ├── molecule-icon.svg
        └── molecule-logo.svg

Convention

GitHub renders <org>/.github/profile/README.md as the org's public landing page. We mirror the same path on Gitea so once GitHub access is restored and repo-sync starts pushing, the file lands in the right place automatically.

Adding more cross-org defaults

GitHub also picks up <org>/.github/CONTRIBUTING.md, SECURITY.md, SUPPORT.md, issue / PR templates under .github/, and workflow templates under .github/workflow-templates/. Add as needed — keep them generic; per-repo overrides win.

Editing

PR against main; org-profile content is user-visible, so pair-review even trivial edits.