docs: follow-ups (CHANGELOG entries, silent mix docs, 4 new examples)#64
Merged
Conversation
Post-overhaul cleanup (follow-up to #63). CHANGELOG: - Add the missing 0.12.13 (custom: provider, #34) and 0.12.12 (memory/context/ AgentServer fixes) entries — both had release tags but no changelog sections — with matching compare-links. mix docs — now 0 warnings: - Qualify `Agent.new/2` -> `Nous.Agent.new/2` (resolves & links) in CHANGELOG. - De-link historical references to since-private/hidden APIs in CHANGELOG and AGENTS.md (run_with_tools/6, Gemini.parse_content/1, Model.default_receive_timeout/1, Provider.request/3, Plugins.Memory.init/2, Nous.Application, Persistence.ETS.TableOwner). New examples (all run or degrade gracefully without a provider): - examples/llm_oneshot.exs — bare Nous.LLM API (generate_text/3, /3 bang, stream_text/3). - examples/knowledge_base.exs — KB store add/search + KB agent plugin. - examples/advanced/summarization.exs — auto-compaction via the Summarization plugin. - examples/advanced/web_tools.exs — WebFetch/SearchScrape/Tavily/Brave tools. - Indexed all four in examples/README.md. Docs: - Clarify the three LiveView examples' distinct roles (patterns reference vs complete chat app vs multi-agent dashboard). Verified: mix format, compile --warnings-as-errors, docs (0 warnings), credo --strict (clean); new examples run green offline. Note: v0.16.2-v0.16.5 are tagged but lack CHANGELOG entries and mix.exs @Version (0.16.1) is behind the latest tag — deferred to a separate version/release reconciliation pass rather than guessing release notes.
mix.exs @Version had been left at 0.16.1 across the v0.16.2-v0.16.5 release tags (each tagged without bumping it). master is 3 commits past v0.16.5, so the next release is 0.16.6. Note: the matching CHANGELOG entries for 0.16.2-0.16.5 are still outstanding (separate version/release reconciliation).
The audit content for releases 0.16.2-0.16.5 had piled up under [Unreleased] and was never versioned (releases were tagged without splitting the changelog). Split it into dated sections using the tag-snapshot delta as ground truth (the [Unreleased] content at each tag = that release's cumulative content): - [0.16.2] 2026-05-16 — provider marshalling, ETS lifecycle, OTP hygiene, telemetry (#58) - [0.16.3] 2026-05-29 — security pass: RCE gate, SSRF, sandbox + audit findings (#59) - [0.16.4] 2026-06-05 — security/OTP/test hardening (#60); summarized from the commit, since this release added nothing to the changelog at the time - [0.16.5] 2026-06-12 — InputGuard fail-closed, permissive execute gate, policy bypass (#61) - [Unreleased] (-> 0.16.6) — perf hot-path hardening (#62) + the docs overhaul (#63) Bullets were moved verbatim, not rewritten; dates match the git tags exactly. Added compare-links for each new version. Verified: no [Unreleased] bullet was dropped, mix docs is 0 warnings, mix format clean.
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.
Follow-up to the documentation overhaul (#63). Docs/examples only — no library behavior changes.
CHANGELOG
0.12.13(custom:provider, feat: consolidate custom provider tocustom:prefix with env var support #34) and0.12.12(memory/context/AgentServer fixes) entries — both had release tags but no changelog sections — plus matching compare-links.mix docs→ 0 warningsAgent.new/2→Nous.Agent.new/2(resolves & links correctly).CHANGELOG.mdandAGENTS.md(run_with_tools/6,Gemini.parse_content/1,Model.default_receive_timeout/1,Provider.request/3,Plugins.Memory.init/2,Nous.Application,Persistence.ETS.TableOwner).New examples (run or degrade gracefully without a provider)
examples/llm_oneshot.exs— bareNous.LLMAPI (generate_text/3, bang,stream_text/3).examples/knowledge_base.exs— KB store add/search + KB agent plugin.examples/advanced/summarization.exs— auto-compaction via the Summarization plugin.examples/advanced/web_tools.exs— WebFetch / SearchScrape / Tavily / Brave.examples/README.md.Docs
Verification
mix format,mix compile --warnings-as-errors,mix docs(0 warnings),mix credo --strict(clean); the new examples run green offline.Deferred (out of scope)
v0.16.2–v0.16.5are tagged but lack CHANGELOG entries, andmix.exs @version(0.16.1) is behind the latest tag (0.16.5). This needs a dedicated version/release reconciliation pass rather than guessed release notes. The README deep-dive trim (optional polish) is also left for a separate PR.Version bump
@version0.16.1→0.16.6. It had been left at0.16.1across thev0.16.2–v0.16.5tags; master is 3 commits pastv0.16.5, so the next release is0.16.6. (The0.16.2–0.16.5CHANGELOG entries are still a separate reconciliation task.)CHANGELOG 0.16.2–0.16.5
[Unreleased]block into dated[0.16.2]–[0.16.5]sections (bullets moved verbatim; dates match the git tags).[0.16.4]is summarized from Audit-pass follow-up: security/OTP/test hardening #60 since that release added nothing to the changelog at the time. Perf perf: agent-runtime hot-path hardening (behavior-preserving) #62 + this docs work sit under[Unreleased]for 0.16.6. Added compare-links. Verified no bullet dropped andmix docsstays at 0 warnings.