Adjust / Update api generator#1105
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…e/parameter rendering update api ref doc generator, add support for type merge, adjust special character rendering update config, update splice wallet kernel references update standard library reference docs, add internal linking Signed-off-by: Ibo Sy <ibo@b9lab.com>
21c223b to
1c525ac
Compare
Signed-off-by: Ibo Sy <ibo@b9lab.com>
|
I found one hosted-preview regression in the The generated source uses <h3 id="">
<a href="#" aria-label="Navigate to header">…</a>
<span><code>%</code></span>
</h3>I also tested the permalink directly. Before clicking it, the URL was: After clicking the heading's permalink, it became: The explicit Could we render a slug-bearing plain-text heading—such as |
Signed-off-by: Ibo Sy <ibo@b9lab.com>
|
Hey @danielporterda good catch - unfortunately, we can not render a % at all in the headlines (always produces a mintlify render error). And because this is formatted in a codeblock, we can also not use other escape characters. So following your proposal, I think the only feasible solution is to drop the "%" completely and just write "modulo" or "modulo operator" for this one. I have added an update, rendering "modulo" instead. |
This PR adjusts and extends the reference doc generation process.
1. Adjust API parameter table rendering
API parameter tables are now rendered using the mintlify ResponseField component.

Files in
docs-main/appdev/reference/daml-standard-library/have been regenerated with new parameter tables.2. Add Daml Script API Reference doc generation
Follow-up from PR 1008, this implements the scripts, configuration and tests to generate the daml script api reference doc section. The generated files have already been added in the linked PR.
Also adds a shared library in scripts/lib/daml_docs_sdk.sh which contains functions (install/damlc/LF resolution) moved out from scripts/generate_daml_standard_library_json.sh to also be reused for the daml script doc generation in scripts/generate_daml_script_json.sh.
3. Update wallet references
Updates repo links and references for
hyperledger-labs/splice-wallet-kerneltocanton-network/wallet4. Fix JSON combine for Daml Standard Library
When combining daml-stdlib and daml-prim JSON for package_set: base, modules with the same name (from -- | MOVE annotations, e.g. Prelude) used first-wins and kept only the stdlib copy. That dropped prim-side types and classes such as Bool and Eq from the generated pages.
This PR fixes base JSON combine for Daml Standard Library: merge same-named modules from daml-stdlib and daml-prim (via scripts/merge_daml_docs_modules.py) so MOVE’d content is kept — restores missing Prelude / DA.Exception / DA.Stack entities. E.g. the Prelude page was missing entries for base types like Decimal, which are now present. Also the rendering has been adjusted to fix a few issues.
Also adjusts the rendering:
Decimal = Numeric 10in two lines, fix rendering in right sidebar%signs in codeblocks in headlines (added a work-around)