Skip to content

docs(cryptify): document staging_mode config option#86

Open
dobby-coder[bot] wants to merge 1 commit into
mainfrom
docs/cryptify-staging-mode
Open

docs(cryptify): document staging_mode config option#86
dobby-coder[bot] wants to merge 1 commit into
mainfrom
docs/cryptify-staging-mode

Conversation

@dobby-coder
Copy link
Copy Markdown
Contributor

@dobby-coder dobby-coder Bot commented May 13, 2026

Summary

  • Document staging_mode config option added in cryptify#152.
  • Repins src/config.rs source link to merge commit ca6be91; adds src/email.rs link for the new staging code path.

Closes #84.

Reviewer quickstart

git fetch origin && git checkout docs/cryptify-staging-mode && npm install && npx vitepress dev docs --port 5173

Then open http://localhost:5173/repos/cryptify and check the Configuration section.

Adds the staging_mode row to the config table and a short Staging mode
subsection describing the [STAGING] log line and the SMTP fields being
ignored. Source links are repinned to the cryptify#152 merge commit
(ca6be91).

Closes #84
@dobby-coder dobby-coder Bot marked this pull request as ready for review May 13, 2026 21:41
@dobby-coder dobby-coder Bot requested a review from rubenhensen May 13, 2026 21:41
@dobby-coder
Copy link
Copy Markdown
Contributor Author

dobby-coder Bot commented May 13, 2026

Tightened the PR description per the no-justification-paragraphs-for-simple-changes rule: dropped the detailed narration of each diff hunk and the Verification section, since the diff is small (one table row + one subsection + two link repins) and self-explanatory. Reviewer quickstart and Closes #84 retained.

Copy link
Copy Markdown
Contributor Author

@dobby-coder dobby-coder Bot left a comment

Choose a reason for hiding this comment

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

Self-review (cannot use --approve on own PR): looks good to merge.

  • Diff matches the PR description: staging_mode row added to config table, new "Staging mode" subsection describing the staging-only log path, config.rs source link repinned to merge commit ca6be91, email.rs source link added.
  • Both source URLs return HTTP 200 at the pinned hash. Content verified: config.rs L3-L36 covers RawCryptifyConfig and CryptifyConfig including the new staging_mode field; email.rs L191-L198 shows the send_email early return when config.staging_mode() is true; L294-L337 contains staging_log_email whose format! line matches the example log entry in the docs verbatim.
  • The claim that the smtp_* settings are ignored under staging mode is consistent with the early return before SMTP setup.
  • npm run docs:build succeeds. Rendered docs/.vitepress/dist/repos/cryptify.html shows the new table row, the Staging mode section, and the repinned source link.
  • Style: no banned words, no em dashes, no bold abuse.

Minor (non-blocking): the email.rs source label lists two ranges (L191-L198, L294-L337) but the URL anchor covers only the first. Acceptable; could be split into two links in a follow-up.

CI is green. Ready for maintainer approval and merge.

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.

docs(cryptify): document staging_mode config option that bypasses SMTP

0 participants