Commit Graph

17 Commits

Author SHA1 Message Date
8bdc77a2c9 chore: automate README docs generation and formatting
Manual `terraform-docs markdown .` was fragile — no injection markers,
no idempotency check, and no consistent formatting pipeline.

Add terraform-docs inject mode with BEGIN/END_TF_DOCS markers in the
README so `terraform-docs .` regenerates only the managed section.
Wrap the injected block with prettier-ignore directives to prevent
prettier from reformatting tables (which would break terraform-docs
--output-check).

Restructure Makefile with three targets:
- `docs`: regenerate terraform-docs + prettier format README
- `fmt`: docs + terraform fmt -recursive
- `check`: verify all docs/formatting are current (CI-friendly)

Add node (LTS) and prettier to .mise.toml for markdown formatting.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-02 14:32:57 +00:00
1c2115b725 Merge pull request #5 from jimeh/docs/fix-truncated-sentence-in-readme 2026-02-02 14:19:20 +00:00
0de0ea55dd docs(readme): fix truncated sentence in Google Workspace example
The sentence about MX records was cut off mid-thought, leaving readers
without the actionable advice to use the records given by Google.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-02 14:18:55 +00:00
36e97775f0 Merge pull request #4 from jimeh/chore/add-claude-code-config 2026-02-02 14:14:45 +00:00
bd2e0128df chore: add Claude Code configuration files
Provide project context and coding guidelines for Claude Code via
AGENTS.md (architecture, conventions, commands) and CLAUDE.md (pointer
to AGENTS.md).

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-02 14:12:11 +00:00
2e5fcffed3 Merge pull request #3 from jimeh/chore/add-mise-config-and-update-docs 2026-02-02 14:11:00 +00:00
52c89c91d2 chore: add mise config and regenerate terraform-docs
Add .mise.toml to pin terraform and terraform-docs tool versions.
Regenerate README.md via terraform-docs, which reformats the
input/output/requirement tables and escapes underscores in markdown
links.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-02 14:10:32 +00:00
1931ed281d docs(readme): expand Example Usage section with more details and examples 2023-04-26 02:48:41 +01:00
fb19a11aae Merge pull request #2 from jimeh/release-please--branches--main v0.0.2 2023-04-26 01:32:04 +01:00
github-actions[bot]
3616fc221d chore(main): release 0.0.2 2023-04-26 00:31:23 +00:00
2738e7c7a1 fix(docs): add README.md to release-please extra-files
This will ensure usage examples in the README always reference the
latest version.
2023-04-26 01:28:34 +01:00
4a2a48a9e7 docs(readme): add Example Usage section 2023-04-26 01:27:13 +01:00
1691c6fa76 fix(docs): correctly describe mx variable 2023-04-26 01:27:13 +01:00
2a4b29eae0 Merge pull request #1 from jimeh/release-please--branches--main v0.0.1 2023-04-26 01:05:40 +01:00
github-actions[bot]
8664cfc4e7 chore(main): release 0.0.1 2023-04-26 00:05:15 +00:00
d162ddc970 ci(release): setup release-please 2023-04-26 01:02:32 +01:00
edbd57893b feat(module): initial implementation 2023-04-26 01:02:08 +01:00