You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for your marvellous work on providing such a fast and well-documented framework for Solidity development! How can one include manual documentation in forge doc?
I tried adding a manual dir docs/manual/hello.md with content:
# hello
some text.
and adding the manual dir in the src line of the book.toml like:
[book]src = ["src", "manual"] # Include both "src" and "manual" directoriestitle = ""[output.html]no-section-label = trueadditional-js = ["solidity.min.js"]additional-css = ["book.css"]git-repository-url = "https://github.com/TruCol/Decentralised-Saas-Investment-Protocol"[output.html.fold]enable = true
However, when I run forge doc --serve, this book.toml is overwritten back to:
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Thank you for your marvellous work on providing such a fast and well-documented framework for Solidity development! How can one include manual documentation in
forge doc
?I tried adding a manual dir
docs/manual/hello.md
with content:# hello some text.
and adding the
manual
dir in thesrc
line of thebook.toml
like:However, when I run
forge doc --serve
, thisbook.toml
is overwritten back to:The
docs/manual/hello.md
and content is preserved however. Hence, I would like to kindly ask:How can one embed manual documentation when auto-generating the documentation with
forge doc
?Beta Was this translation helpful? Give feedback.
All reactions