docs: document well-known discovery workflow and exclude internal assets - #24
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
_config.yml excludes css/, images/, and js/ even though site pages reference those assets, which would break the deployed site.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR documents the repository’s .well-known discovery generation workflow (GLEIF/KERI) and updates the Jekyll build configuration to avoid publishing internal source/build artifacts.
Changes:
- Added a README section describing the
.well-knownasset source layout, generation script, and update procedure. - Expanded Jekyll
_config.ymlexcludeentries to prevent publishing internal directories/files. - Updated
scripts/build-wellknown.pydocstring/example command to targethttps://provenant.net.
File summaries
| File | Description |
|---|---|
| scripts/build-wellknown.py | Updates generation-script documentation and example invocation host. |
| README.md | Adds .well-known discovery workflow documentation and update instructions. |
| _config.yml | Adjusts Jekyll exclude list to control what gets published to GitHub Pages. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
There was a problem hiding this comment.
🟡 Changes recommended
The well-known build script still defaults --host to https://weboftrust.github.io, which can generate incorrect host-meta.json output if the flag is omitted.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Review details
- Files reviewed: 10/30 changed files
- Comments generated: 1
- Review effort level: Lite
Summary
README.mdexplaining the GLEIF & KERI.well-knowndiscovery architecture, source asset layout (well-known-assets/), and compilation procedure usingscripts/build-wellknown.py.scripts), source trees (well-known-assets), scratch research files (dns-research-file.txt), internal explainer (WELL-KNOWN.md), and legacy folders (css,images,js) to theexcludelist in_config.ymlto prevent unintended public deployment.scripts/build-wellknown.pyto targethttps://provenant.net.