Skip to content

Add practical walkthroughs and stronger validation#6

Merged
PrzemyslaV88 merged 1 commit into
mainfrom
improve-public-method-kit
May 31, 2026
Merged

Add practical walkthroughs and stronger validation#6
PrzemyslaV88 merged 1 commit into
mainfrom
improve-public-method-kit

Conversation

@PrzemyslaV88
Copy link
Copy Markdown
Owner

Summary

  • add beginner getting-started path and 10-minute README flow
  • add full fake walkthroughs, filled template examples, playbooks, and checklists
  • expand glossary and technique cards with stronger evidence guidance
  • add npm test with unsafe fixture assertions and index freshness checks
  • update CI to run npm test and strengthen contribution safety

Validation

  • npm install
  • npm run generate:index
  • npm run check
  • npm run check:frontmatter
  • npm run check:index-current
  • npm test
  • node tools/secret-pattern-check.mjs test-fixtures/unsafe (expected failure)
  • node tools/redaction-check.mjs test-fixtures/unsafe (expected failure)

@PrzemyslaV88 PrzemyslaV88 merged commit d1002a3 into main May 31, 2026
4 checks passed
@PrzemyslaV88 PrzemyslaV88 deleted the improve-public-method-kit branch May 31, 2026 00:56
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

Here are some automated review suggestions for this pull request.

Reviewed commit: b8f9c0c584

ℹ️ 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".

Comment thread docs/getting-started.md
@@ -0,0 +1,101 @@
# Getting Started
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Record major documentation additions in the log

This commit adds a new getting-started guide plus walkthroughs, playbooks, checklists, and filled examples, but knowledge/log.md is not updated. The repo instructions in AGENTS.md explicitly require updating knowledge/log.md when adding major documentation, so this docs batch will be missing from the project change log that future readers and agents rely on.

Useful? React with 👍 / 👎.

Comment on lines +19 to +20
} else {
console.log(`${name} correctly failed against unsafe fixtures.`);
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Assert the specific unsafe fixture failures

Because the new fixture test treats any non-zero exit as success for the whole unsafe directory, one detector regression can be masked by a different fixture still failing; for example, redaction URL detection could stop working while the UUID fixture keeps redaction-check non-zero. That means npm test can report that unsafe fixtures are covered without proving each intended unsafe pattern is still detected, so the helper should scan fixtures individually or verify expected findings in the output.

Useful? React with 👍 / 👎.

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