Repository navigation
docs: align v3.3.0 docs with actual config, install, and env behavior - #196
Merged
Merged
Conversation
Correct config layering to match load_layered_config (--config-file, not auto-loaded .structkit.yaml), document Homebrew and Linux workflow artifacts, and list every STRUCTKIT_* env var with its real default. Co-authored-by: Kenneth Belitzky <kenny@belitzky.com>
MkDocs cannot resolve ../packaging/README.md from docs_dir, so use the repository URL instead of a broken relative path. Co-authored-by: Kenneth Belitzky <kenny@belitzky.com>
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.
Issue
Docs-only cleanup after the v3.3.0 release. No runtime behavior changes (docstring-only update in
structkit/config.py).Description
This PR brings the docs in line with what the code actually does after v3.3.0.
Config layering. Docs claimed
.structkit.yamlwas auto-loaded as project CLI config.load_layered_config/main.pyonly apply a project layer from--config-file. Documented merge order is now: built-in defaults →~/.config/struct/config.yaml→--config-file→ CLI flags..structkit.yamlis described as the structure definition, not layered CLI config.User config vs sources are documented as two separate files, without moving either:
~/.config/struct/config.yaml(as in code; not XDG-overridable)~/.config/structkit/sources.yaml(XDG-aware;STRUCTKIT_SOURCES_CONFIG)Install. Homebrew formula is
structkitin taphttpdss/homebrew-structkit:brew install httpdss/structkit/structkit. Linux.deb/.rpmpackages are not attached to GitHub Releases (confirmed on v3.3.0: empty assets). They are workflow artifacts frombuild-linux-packages, or can be built locally perpackaging/README.md.Environment variables.
docs/environment-variables.mdnow covers everySTRUCTKIT_*env var from a code grep, with real defaults.STRUCTKIT_LOG_LEVELoverrides--log/--debug.STRUCTKIT_DENY_NETWORKis only1. There is noSTRUCTKIT_YAMLruntime env var (only theBASIC_STRUCTKIT_YAMLconstant ininit.py), so it is not documented.mkdocs
site_url. Set tohttps://structkit.app/docs/to matchpyproject.tomlDocumentation. That is the URL that actually serves docs today;https://httpdss.github.io/structkit/returns 404.extra.homepageishttps://structkit.app/. Nav now includes CLI reference, custom structures, and environment variables. The previous “Custom Structures” nav entry pointed atstructures.md(the bundled catalog); that is now “Built-in Structures”, withcustom-structures.mdas “Custom Structures”.Also: README key features + ecosystem;
docs/index.mdecosystem links;docs/github-integration.mddocumentshttpdss/structkit-actionfor validate / diff / generate next to the reusable workflow;latest_releaseexamples and the workflow version hint updated to 3.3.0; Copilot prompt linkhttpdss/struct→httpdss/structkit.Checklist
mkdocs buildsucceeds (pre-existing link warnings only;installation.mdpackaging link uses the GitHub URL so MkDocs can resolve it)pre-commit run --all-filespassed (check-yaml, end-of-file-fixer, trailing-whitespace)