Skip to content

PR #9: Reference documentation - #36

Merged
saengland merged 4 commits into
main2from
review/09-reference-docs
May 7, 2026
Merged

PR #9: Reference documentation#36
saengland merged 4 commits into
main2from
review/09-reference-docs

Conversation

@saengland

Copy link
Copy Markdown
Collaborator

Note: This PR replaces the original #19, which was auto-closed when main was rolled back during a tooling-incident recovery earlier today.
The branch (review/09-reference-docs) and code are unchanged - re-opening here against main2 so it fits the staging-then-rename flow with the other six replacements (#28-#33).

Original PR body preserved below.


Adds the ESS reference documentation under solutions/ess-agent-kit/src/reference/ess-docs/:

  • customization/ ΓÇö agent customization patterns
  • deployment/ ΓÇö deployment guidance
  • flightcheck/ ΓÇö FlightCheck usage docs
  • integrations/ ΓÇö ServiceNow, Workday integration guides
  • operations/ ΓÇö operational guidance

46 markdown files. Pulled together from official Microsoft documentation; review for accuracy and any internal-only references.

Tracker: #10

Adds the ESS reference documentation under solutions/ess-agent-kit/src/reference/ess-docs/:
- customization/ - agent customization patterns
- deployment/ - deployment guidance
- flightcheck/ - FlightCheck usage docs
- integrations/ - ServiceNow, Workday integration guides
- operations/ - operational guidance

46 markdown files. Pulled together from official Microsoft documentation; review for accuracy and any internal-only references.

Reviewer: @CavillMason
Tracker: #10
rename solutions/ess-agent-kit -> solutions/ess-maker-skills
Adds src/reference/ess-docs/README.md documenting the snapshot policy: why the docs are vendored (Copilot Chat grounding), source URL, snapshot date (2026-04-29), refresh policy (hand-PR; the auto-sync script was removed in slice PR #3 for corp-NAT rate-limit + silent-overwrite reasons), and explicit non-goals (not a fork, not the place for kit-specific guidance).

Addresses the 'feels wasteful to be cloning those' concern raised by @johnguy0 in the PR #29 review thread. The duplication is the explicit tradeoff that gives the kit its domain-correct first-turn output quality; the snapshot stamp makes the staleness contract explicit.

Companion: src/examples/ess-samples/ gets an analogous README in slice PR #10.
@saengland
saengland merged commit 7cd7c54 into main2 May 7, 2026
4 checks passed
@saengland
saengland deleted the review/09-reference-docs branch May 7, 2026 17:52
saengland added a commit that referenced this pull request May 7, 2026
…er approval; restoring branch for proper review
@saengland
saengland restored the review/09-reference-docs branch May 7, 2026 17:57
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