docs: fix ex_doc broken references#59
Merged
Merged
Conversation
ex_doc emitted five warnings on every build: - guides/self-hosting.md and LICENSE exist but were not in the ex_doc extras list, so the README links to them did not resolve. Added both (self-hosting.md to the Guides group). - lua-scripting.md's Next Steps linked configuration.md and websocket-protocol.md, which do not exist in this repo. Repointed them to the canonical pages on asobi.dev and added the self-hosting link. - security-trust-model.md autolinked asobi_lua_loader:bounded_eval/2, which is private (ADR 0002 keeps it for init/tick/get_state but it is not exported). Reworded to name the wrapper without the dead autolink. ex_doc now builds with zero warnings.
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.
Clears the five long-standing ex_doc warnings (surfaced during the docs-drift audit follow-up).
Fixes
guides/self-hosting.md+LICENSEexist but were missing from the ex_docextraslist, so the README links to them never resolved to generated pages. Added both (self-hosting.mdjoins the Guides group;license.htmlnow renders).configuration.md/websocket-protocol.mdwere dead links inlua-scripting.md's Next Steps — no such files exist in this repo. Repointed to the canonical pages on asobi.dev (/docs/configuration,/docs/protocols/websocket) and added a Self-hosting link.asobi_lua_loader:bounded_eval/2insecurity-trust-model.mdautolinked a private function (ADR 0002 keepsbounded_evalforinit/tick/get_state, but it isn't exported), so ex_doc warned. Reworded to name the wrapper without the broken autolink.Verification
rebar3 ex_docnow builds with zero warnings;rebar3 fmt --checkandcompileclean.doc/is gitignored, so no generated output is committed.