docs: add samples and BOM journey - #117
Merged
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 6d10f85a-7a25-43b0-bcb2-abf87810f1b2
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 6d10f85a-7a25-43b0-bcb2-abf87810f1b2
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository’s documentation landing experience to be task-oriented, and adds two “journey” docs that clarify how to use Terraform workspace samples and how to select SAP/BOM definitions within the SDAF ecosystem.
Changes:
- Replaces the minimal README landing content with task-based navigation and clearer execution-model boundaries.
- Adds two new docs describing (1) Terraform workspace sample usage and (2) SAP/BOM catalog selection and validation.
- Introduces a CONTRIBUTING guide that centralizes contribution requirements while keeping the README concise.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | New task-based navigation and clearer guidance on repository boundaries and usage. |
| docs/01-00-terraform-samples.md | New end-to-end guide for selecting/copying Terraform workspace samples into a customer configuration repo. |
| docs/02-00-bom-samples.md | New end-to-end guide for selecting SAP/BOM definitions, setting BOM_directory, and validating acquisition inputs. |
| CONTRIBUTING.md | New contribution guidance covering scope/ownership, validation expectations, and doc/style requirements. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
hdamecharla
approved these changes
Jul 26, 2026
hdamecharla
left a comment
hdamecharla
left a comment
Member
There was a problem hiding this comment.
Approved. Merge the latest changes from main into this branch before merging the PR.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
BOM_directory, catalog ownership, and execution-model boundariesSUPPORT.mdValidation
git diff --check