-
Notifications
You must be signed in to change notification settings - Fork 0
Feature - Improve Validate Docs Code Blocks #205
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
5bb3d18
9e5cd02
3a1f67c
d070725
06a46b0
d3e142a
5242e2f
32d86c4
47a1ffa
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,33 @@ | ||
| --- | ||
| <<<<<<< HEAD | ||
| date: YYYY-MM-DD | ||
| deciders: | ||
| - Names/Roles | ||
| doc_uuid: 7bd8659a-a8e7-4fb1-854d-daf5741c19d3 | ||
| project_id: prism-data-layer | ||
| status: | ||
| - Proposed | Accepted | Deprecated | Superseded by ADR-YYY | ||
| tags: | ||
| - backend | ||
| - proxy | ||
| - security | ||
| - performance | ||
| - testing | ||
| title: 'ADR-XXX: [Short Title]' | ||
| --- | ||
|
|
||
| ## Context | ||
|
|
||
| What is the issue we're facing and the context around it? What are we trying to achieve? | ||
|
|
||
| ## Decision | ||
|
|
||
| What is the change we're proposing/announcing? | ||
|
|
||
| ## Rationale | ||
|
|
||
| Why did we choose this approach? What alternatives did we consider? | ||
| ======= | ||
| # REQUIRED FIELDS - ALL must be present for validation to pass | ||
| title: 'ADR-XXX: Title Here' # Must start with "ADR-XXX:" where XXX is 3-digit number | ||
| status: Proposed # One of: Proposed | Accepted | Implemented | Deprecated | Superseded | ||
|
|
@@ -57,10 +86,42 @@ What factors did we consider? (Optional: use weighted scoring) | |
| - **Performance** (weight: X%): Description | ||
| - **Developer Experience** (weight: Y%): Description | ||
| - **Cost/Maintenance** (weight: Z%): Description | ||
| >>>>>>> origin/main | ||
|
||
|
|
||
| ### Alternatives Considered | ||
|
|
||
| 1. **Alternative 1**: Description | ||
| <<<<<<< HEAD | ||
| - Pros: ... | ||
| - Cons: ... | ||
| - Rejected because: ... | ||
|
|
||
| 2. **Alternative 2**: Description | ||
| - Pros: ... | ||
| - Cons: ... | ||
| - Rejected because: ... | ||
|
|
||
| ## Consequences | ||
|
|
||
| ### Positive | ||
|
|
||
| - What becomes easier | ||
| - What capabilities do we gain | ||
|
|
||
| ### Negative | ||
|
|
||
| - What becomes harder | ||
| - What trade-offs are we making | ||
|
|
||
| ### Neutral | ||
|
|
||
| - What stays the same | ||
| - What new considerations emerge | ||
|
|
||
| ## Implementation Notes | ||
|
|
||
| Key technical details, gotchas, or migration steps. | ||
| ======= | ||
|
Comment on lines
+94
to
+124
|
||
| - **Pros**: | ||
| - Benefit 1 | ||
| - Benefit 2 | ||
|
|
@@ -105,11 +166,24 @@ What are the implications of this decision? | |
| Optional section for implementation details, milestones, or technical specifics. | ||
|
|
||
| Key technical details, gotchas, or migration steps: | ||
| >>>>>>> origin/main | ||
|
||
|
|
||
| ```rust | ||
| // Example code if relevant | ||
| ``` | ||
|
|
||
| <<<<<<< HEAD | ||
| ## References | ||
|
|
||
| - [Link to related ADRs] | ||
| - [Link to external resources] | ||
| - [Link to requirements docs] | ||
|
|
||
| ## Revision History | ||
|
|
||
| - YYYY-MM-DD: Initial draft | ||
| - YYYY-MM-DD: Accepted after review | ||
| ======= | ||
|
Comment on lines
+175
to
+186
|
||
| **Migration Steps** (if applicable): | ||
| 1. Step one | ||
| 2. Step two | ||
|
|
@@ -128,3 +202,4 @@ Key technical details, gotchas, or migration steps: | |
| - YYYY-MM-DD: Initial draft (Author Name) | ||
| - YYYY-MM-DD: Accepted after review (Deciders) | ||
| - YYYY-MM-DD: Amended with clarification (Author Name) | ||
| >>>>>>> origin/main | ||
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unresolved Git merge conflict in YAML frontmatter. The frontmatter structure must be resolved by choosing one version or merging the fields appropriately, and all conflict markers must be removed.