dot-github--logos

Quick Start

A newcomer’s entry point for organvm/dot-github--logos and the wider ORGAN-V: Logos repository set — the public-process layer of the organvm system. This guide answers the two questions people ask first: which repository do I clone? and how do I run it locally?

New to the organ itself? Read the organization profile for what ORGAN-V is and why it exists. This guide is purely operational.

Community questions and open-ended feedback belong in GitHub Discussions. Use issues for scoped bugs, documentation fixes, or implementation requests.

1. Which repository do I clone first?

There is no single “main” repo to clone — ORGAN-V is a small constellation of repositories, each with one job. Pick the one that matches your goal.

If you are here from an issue in organvm/dot-github--logos, clone this repository first:

git clone https://github.com/organvm/dot-github--logos.git
cd dot-github--logos

This repo owns the organization profile, community health files, issue/PR templates, lightweight workflows, and this guide. It is the right starting point for documentation and governance issues filed here.

If you are trying to understand or edit ORGAN-V’s published work, start with public-process instead:

I want to… Clone this repo Stack
Read or edit the essays (the flagship content) public-process Jekyll static site
Work on essay automation (monitor, narrator, validator, indexer) essay-pipeline Code/automation
Work on engagement analytics (GoatCounter, metrics, dashboards) analytics-engine Code/automation
Update voice guide, rubrics, or frontmatter schema editorial-standards Docs + schemas
Curate reading lists / RSS feeds reading-observatory Code/automation
Change org-wide governance (templates, this guide) dot-github--logos Governance/docs

If you’re just exploring and don’t know where to start, clone public-process. It is the flagship repository — the live essay site — and it gives you the clearest picture of what this organ produces. The published site is at organvm-v-logos.github.io/public-process.

2. How do I run it locally?

Every repository documents its own exact setup and validation commands in its README.md. The repo README is always the source of truth — start there after cloning. The patterns below get you moving.

This governance repo (dot-github--logos)

This repository does not run a web app or local service. Most changes are Markdown, YAML, issue templates, or GitHub workflow files. To work locally:

git clone https://github.com/organvm/dot-github--logos.git
cd dot-github--logos

# If your Python does not already have PyYAML, use a local ignored venv.
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install PyYAML

# Optional: enable the local policy hook used before commits.
git config core.hooksPath .githooks

# Run the same lightweight checks as CI.
python3 - <<'PY'
from pathlib import Path
import re
import sys
import yaml

errors = []

if not Path("README.md").exists() and not Path("profile/README.md").exists():
    errors.append("No README.md or profile/README.md found")

if Path("seed.yaml").exists():
    try:
        yaml.safe_load(Path("seed.yaml").read_text(encoding="utf-8"))
    except Exception as exc:
        errors.append(f"seed.yaml is invalid YAML: {exc}")

for workflow in sorted(Path(".github/workflows").glob("*.yml")):
    try:
        yaml.safe_load(workflow.read_text(encoding="utf-8"))
    except Exception as exc:
        errors.append(f"{workflow}: {exc}")

for template in sorted(Path(".github/ISSUE_TEMPLATE").glob("*.md")):
    if not template.read_text(encoding="utf-8").startswith("---"):
        errors.append(f"{template}: missing YAML frontmatter block")

secret_patterns = [
    re.compile(r"sk-[a-zA-Z0-9]{20,}"),
    re.compile(r"ghp_[a-zA-Z0-9]{36}"),
    re.compile(r"AKIA[A-Z0-9]{16}"),
]
for path in Path(".").rglob("*"):
    if ".git" in path.parts or ".github" in path.parts or not path.is_file():
        continue
    try:
        text = path.read_text(encoding="utf-8")
    except UnicodeDecodeError:
        continue
    for pattern in secret_patterns:
        if pattern.search(text):
            errors.append(f"{path}: potential secret pattern {pattern.pattern}")

if errors:
    print("\n".join(errors))
    sys.exit(1)

print("Local governance checks passed")
PY

General pattern (any repo)

# 1. Clone
git clone https://github.com/organvm-v-logos/<repo-name>.git
cd <repo-name>

# 2. Read the README first — it lists the real setup + validation commands
#    Look for an `## Setup`, `## Getting Started`, or `## Development` section.

# 3. Install dependencies (whichever the repo uses)
npm install        # for TypeScript/Node repos
# or
pip install -r requirements.txt   # for Python repos

# 4. Run the repo's validation commands (tests / lint) before changing anything

The essay site (public-process)

public-process is a Jekyll site. To preview essays locally:

git clone https://github.com/organvm-v-logos/public-process.git
cd public-process
bundle install
bundle exec jekyll serve   # → http://localhost:4000

Then open the local URL in a browser. Confirm the exact command in that repo’s README — it is authoritative if it differs from the above.

Code / automation repos

essay-pipeline, analytics-engine, and reading-observatory are code repositories. Per the contribution standards they use:

After installing dependencies, run the repo’s test command (listed in its README) to confirm a working local setup before making changes.

3. First contribution

Once you can run things locally:

  1. Pick an issue labeled good first issue.
  2. Confirm scope, validation commands, and acceptance criteria before coding.
  3. Fork → branch (feature/your-feature or fix/your-fix) → keep changes focused.
  4. Run the repo’s local validation commands.
  5. Open a PR with a clear description.

Full details — accepted change types, review SLAs, development standards — are in CONTRIBUTING.md.

Where to go next

Part of the organvm eight-organ system · ORGAN-V: Logos

This site is open source. Improve this page.