Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix docs broken link #2369

Closed
wants to merge 1 commit into from
Closed

fix docs broken link #2369

wants to merge 1 commit into from

Conversation

jonathanlei
Copy link

High Level Overview of Change

The docs site js.xrpl.org has broken links for Case by Case Setup Steps, this PR fixes it

<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>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way in typedoc to populate urls? This approach will not link properly for branches.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator

@intelliot intelliot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this is the right place to fix the links. Isn't docs/index.html generated by TypeDoc?

https://github.com/XRPLF/xrpl.js/blob/74de24cf75ff5a3d42ebe2fa17c9733812103881/CONTRIBUTING.md#generate-reference-docs

@jonathanlei
Copy link
Author

I'm not sure this is the right place to fix the links. Isn't docs/index.html generated by TypeDoc?

https://github.com/XRPLF/xrpl.js/blob/74de24cf75ff5a3d42ebe2fa17c9733812103881/CONTRIBUTING.md#generate-reference-docs

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

@ckniffen
Copy link
Collaborator

ckniffen commented Jul 6, 2023

I'm not sure this is the right place to fix the links. Isn't docs/index.html generated by TypeDoc?

https://github.com/XRPLF/xrpl.js/blob/74de24cf75ff5a3d42ebe2fa17c9733812103881/CONTRIBUTING.md#generate-reference-docs

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.

@ckniffen ckniffen deleted the fix-docs-broken-link branch November 1, 2023 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants