docs: add BA onboarding guide and branch/PR GitHub Pages docs previews#1
Open
docs: add BA onboarding guide and branch/PR GitHub Pages docs previews#1
Conversation
|
Documentation preview is available.
Branch and PR previews are only published for branches inside this repository. |
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
1 participant
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.
Change description
Adds a full beginner-focused onboarding guide for opal-rm-prototype and publishes it through GitHub Pages.
This change:
rewrites the README.md for business analysts and designers with step-by-step Windows and Mac setup, Git/GitHub basics, SSH setup, clone/run instructions, and day-to-day Git commands
adds a split documentation site under docs/ with dedicated pages for setup, troubleshooting, GitHub Pages, and using Codex for prototyping
adds explicit BA/designer guidance for how to start Codex in this repo, what files it should change, and example prompts for safe prototype changes
adds a GitHub Pages workflow that publishes:
latest/ from main
branches// from branch pushes
pulls/pr-/ from same-repo PR updates
keeps documentation publishing separate from the existing Azure deployment workflow for the prototype app
Testing done
Documentation and workflow validation only. This is a docs/config change and does not change prototype journey logic.
Executed:
codex --help
.venv/bin/mkdocs build --strict
.venv/bin/python -c "import yaml, pathlib; yaml.safe_load(pathlib.Path('.github/workflows/docs-pages.yml').read_text())"
git diff --check
Results:
MkDocs build passed
GitHub Actions workflow YAML parsed successfully
Diff whitespace check passed
Confirmed local Codex CLI is available so the new beginner start-flow instructions are grounded in the current environment
No automated application tests were added because this PR does not change runtime prototype behaviour.
Security Vulnerability Assessment
CVE Suppression: Are there any CVEs present in the codebase (either newly introduced or pre-existing) that are being intentionally suppressed or ignored by this commit?
Yes
No
Checklist
commit messages are meaningful and follow good commit message guidelines
README and other documentation has been updated / added (if needed)
tests have been updated / new tests has been added (if needed)
Does this PR introduce a breaking change.