Skip to content

docs(refid): add ID pattern catalog - #185

Open
sthanikan2000 wants to merge 1 commit into
mainfrom
docs/refid-id-pattern-catalog
Open

docs(refid): add ID pattern catalog#185
sthanikan2000 wants to merge 1 commit into
mainfrom
docs/refid-id-pattern-catalog

Conversation

@sthanikan2000

Copy link
Copy Markdown
Collaborator

Summary

  • Add refid/docs/PATTERNS.md, cataloging the ID shapes producible from refid's segment grammar (literal, list, date, sequence) and the sequence reset-cadence dimensions, each backed by a runnable example Config.
  • Link the new doc from refid/README.md right after the Scope Key Placeholders section.

Test plan

  • go test -race ./... passed (via pre-push hook)
  • Docs-only change; no code paths affected

@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 4ae7c678-f29d-4c28-8ee8-29bfda306826


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sthanikan2000 sthanikan2000 self-assigned this Sep 4, 2026
Catalogs the shapes producible from refid's segment grammar (literal,
list, date, sequence) and sequence reset cadences, with a runnable
example config per shape, and links it from the README.
@sthanikan2000
sthanikan2000 force-pushed the docs/refid-id-pattern-catalog branch from a36c129 to 233ed29 Compare September 4, 2026 07:36

@ginaxu1 ginaxu1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

non-blocking nits:

  1. Example IDs use 000042. 1st call is 000001. Same convention as the existing README; a one-liner would make that obvious
  2. Line-number links will rot. registry.go:173–187 is accurate today; a later edit will silently point at the wrong function. Symbol names are more durable.
    3.*Section 2 slightly overstates "placeholders only" Isolation is the fully resolved scope-key string. P8’s :primary / :secondary suffixes also split counters
  3. Shared scopeKey on two sequences does more than "share one counter": one Generate consumes two increments (A-000001-000002). Worth one sentence in P8.
  4. Visible ID and reset cadence are independent. You can put a daily date in the ID and a never-resetting sequence (or the reverse). The catalog couples them in examples but never says that mismatch is legal and easy to misconfigure.
  5. "Reset" is a new scope_key row, not truncation of the old counter. Matches existing README language, so not a new inaccuracy

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.

2 participants