fix docs broken link #2369
fix docs broken link #2369
Conversation
| <li><a href="./UNIQUE_SETUPS.md#using-xrpljs-with-react-native">Using xrpl.js with <code>React Native</code></a></li> | ||
| <li><a href="./UNIQUE_SETUPS.md#using-xrpljs-with-vite-react">Using xrpl.js with <code>Vite React</code></a></li> | ||
| <li><a href="./UNIQUE_SETUPS.md#using-xrpljs-with-deno">Using xrpl.js with <code>Deno</code></a></li> | ||
| <li><a href="https://github.com/XRPLF/xrpl.js/blob/main/UNIQUE_SETUPS.md#using-xrpljs-from-a-cdn">Using xrpl.js with a CDN</a></li> |
There was a problem hiding this comment.
Is there a way in typedoc to populate urls? This approach will not link properly for branches.
There was a problem hiding this comment.
the problem is that the docs don't generate separate pages for github pages, I'll look into the typedoc again and find a solution
the problem is that the docs don't generate separate pages for github pages (so the relative url before would go to 404), I'll look into the typedoc again and find a solution |
It is created from typedoc from the README. There are several issues opened for this with typedoc. What it comes down to is typedoc cannot generate markdown except for the index. One solution is to use docusaurus and its typedoc plugin that will generate the api pages in typedoc and all other documention is generated from markdown files. |
High Level Overview of Change
The docs site js.xrpl.org has broken links for Case by Case Setup Steps, this PR fixes it