question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

API Reference Docs are broken

See original GitHub issue

When v5 was recently released, the docs were not published quite right. There is no way to navigate around the API reference section (link) like you could with v4. Instead of dropping you into the root of the API, it puts you in a subsection on Identifiers. There is no way to get to the API reference for the Model class for instance, without clicking through into Association and then find a method that has a reference to Model. Before, the API Reference had all of the main classes listed in the side bar that you could drill down into.

The v4 docs are also mostly unusable currently, as the link for them just points to the docs folder in the v4 branch. The API Reference docs are generated by code, and are not usable via browsing the git branch. I’ve had to resort to a third party mirror? to be able to get access to v4 API Reference docs.

Issue where docs were updated: #10475

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Reactions:1
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
SimonSchickcommented, Mar 20, 2019

@sushantdhiman it might be helpful to group datatypes into their own category, I will look into this.

0reactions
SimonSchickcommented, Mar 25, 2019

The easiest way to fix it would be to move the data type file into a subfolder. The cleaner solution would be to split all data types into separate files inside of the data-types folder.

Read more comments on GitHub >

github_iconTop Results From Across the Web

API reference docs are broken · Issue #1280 · polyaxon/polyaxon ...
Clicking on the 'Rest API' link at the bottom of https://polyaxon.com/docs/references/ takes you to https://polyaxon.com/docs/api/, which is a broken page.
Read more >
firebase/firestore - JavaScript API reference - Google
Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken.
Read more >
NVIDIA DeepStream SDK API Reference: Main Page
This API Documentation describes the NVIDIA APIs that you can use to ... Each high-level module may be further broken down into functional ......
Read more >
Urgent-ish! API Reference Docs broken, return 404!
API Reference Docs broken, return 404! The API Reference (doxygen-generated) documentation that's crucial for plugin developers, and has been ...
Read more >
docusaurus.config.js
The behavior of Docusaurus when it detects any broken link. By default, it throws an error, to ensure you never ship any broken...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found