Skip to content

Reorganize repository documentation into overview, developer, and operations layers#179

Merged
tomvothecoder merged 6 commits into
E3SM-Project:mainfrom
tomvothecoder:docs/improve-docs
May 8, 2026
Merged

Reorganize repository documentation into overview, developer, and operations layers#179
tomvothecoder merged 6 commits into
E3SM-Project:mainfrom
tomvothecoder:docs/improve-docs

Conversation

@tomvothecoder
Copy link
Copy Markdown
Collaborator

Description

  • No linked issue.
  • Restructure the root README into a concise project landing page.
  • Add a dedicated CONTRIBUTING.md and docs/developer/README.md for contributor workflow, setup, and architecture.
  • Rework the docs index by audience and clarify the role of specialized operations docs.
  • Update backend/frontend READMEs and internal reference pointers to match the new documentation ownership model.

Checklist

  • Code follows project style guidelines
  • Self-reviewed code
  • No new warnings
  • Tests added or updated (if needed)
  • All tests pass (locally and CI/CD)
  • Documentation/comments updated (if needed)
  • Breaking change noted (if applicable)

Deployment Notes (if any)

  • No deployment changes. Documentation-only update.
  • Validation run: git diff --check on the changed Markdown files.

- Clarify NERSC Spin hosting for the full application
- Replace 'HPC sites submit' with ingestion jobs that push data
- Replace 'Site-side wrappers' with 'Site-side ingestion jobs'
- Add prerequisite links and command annotations
- Remove unreferenced SVG asset
- Add LICENSE file
…developer guide

- Daily Workflow section with common commands, DB reset, and single-test patterns
- Making a Change walkthrough with backend and frontend examples
- Troubleshooting section covering Docker, env vars, SSL, PATH, pre-commit,
  cross-feature imports, and DB sync issues
@tomvothecoder tomvothecoder marked this pull request as ready for review May 8, 2026 22:39
@tomvothecoder tomvothecoder merged commit 22a5b39 into E3SM-Project:main May 8, 2026
1 check passed
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

.PHONY: frontend-install frontend-clean frontend-local frontend-build frontend-preview frontend-lint frontend-fix

P2 Badge Reintroduce frontend-local command behavior

The commit removes the frontend-local recipe but leaves frontend-local in .PHONY, so make frontend-local now exits successfully with “Nothing to be done” instead of starting the dev server as it did before. This is a silent regression for any local workflow or script still invoking that target, because the command appears to succeed while doing nothing.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@tomvothecoder tomvothecoder deleted the docs/improve-docs branch May 11, 2026 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant