Skip to content

docs: overhaul documentation and introduce .serverless-full-stack-webapp-starter-kit/ directory#125

Merged
konokenj merged 1 commit intomainfrom
feature/documentation-overhaul
Mar 20, 2026
Merged

docs: overhaul documentation and introduce .serverless-full-stack-webapp-starter-kit/ directory#125
konokenj merged 1 commit intomainfrom
feature/documentation-overhaul

Conversation

@konokenj
Copy link
Contributor

Issue

close #109
close #111

Changes

  • AGENTS.md: New file. Development guide with irreducible knowledge only — authentication patterns, async job dispatch, DB migration, Lambda constraints, coding conventions, and guardrails. 80 lines, designed to work in copied projects.
  • DESIGN_PRINCIPLES.md: New file at .serverless-full-stack-webapp-starter-kit/design/. Kit maintainer context — quality standards, design decisions, technology choice rationale, ADR policy.
  • README.md: Rewritten with Getting started flow (copy → customize → deploy → add features), maintenance policy, updated image paths, contributor credits.
  • CONTRIBUTING.md: Added language policy and Conventional Commits (Angular style).
  • webapp/README.md: Simplified to local dev setup and env var notes, delegates to AGENTS.md.
  • imgs/: Moved to .serverless-full-stack-webapp-starter-kit/docs/imgs/.
  • AmazonQ.md, webapp/AmazonQ.md: Deleted (consolidated into AGENTS.md).

Verification

  • README.md image paths resolve correctly
  • AGENTS.md is self-contained (no dependency on README.md or .serverless-full-stack-webapp-starter-kit/)
  • All links between documents are valid

…app-starter-kit/ directory (#109, #111)

- Add AGENTS.md with development guide for AI coding agents
- Add DESIGN_PRINCIPLES.md for kit maintainers
- Move imgs/ to .serverless-full-stack-webapp-starter-kit/docs/imgs/
- Rewrite README.md with Getting started flow and maintenance policy
- Update CONTRIBUTING.md with language policy and Conventional Commits
- Simplify webapp/README.md, delegate to AGENTS.md
- Delete AmazonQ.md and webapp/AmazonQ.md
@konokenj konokenj merged commit a463b5c into main Mar 20, 2026
5 checks passed
@konokenj konokenj deleted the feature/documentation-overhaul branch March 20, 2026 07:24
@konokenj konokenj restored the feature/documentation-overhaul branch March 20, 2026 07:24
@konokenj konokenj deleted the feature/documentation-overhaul branch March 20, 2026 07:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant