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

Improved node docs #1902

Merged
merged 6 commits into from
Jul 2, 2023
Merged

Conversation

RunDevelopment
Copy link
Member

Changes:

  • Removed examples API.
  • Added "See Also" section. It just contains links to other nodes.
  • Changed python API for descriptions. All methods that take secription now support lists. Lists items are joined together using \n\n. This makes it easy to write paragraphs. E.g. withDocs("para1", "para2")
  • Renamed widthDocumentation to withDocs.
  • Changed links to other nodes. Instead of using empty links, I switched to inline code. E.g. `chainner:ncnn:load_model`. This is easier to use, and it gives us something to fall back on when the schema id is invalid (e.g. because the node isn't installed).
  • Added more documentation to a few nodes.

image

joeyballentine
joeyballentine previously approved these changes Jun 30, 2023
src/renderer/components/NodeDocumentation/NodeDocs.tsx Outdated Show resolved Hide resolved
@joeyballentine
Copy link
Member

I didn't mean to approve that. I think you missed the markdown customization in the node description tooltips -- those have to properly convert the schema ID code block to a node name as well

@joeyballentine joeyballentine merged commit 2b31e83 into chaiNNer-org:main Jul 2, 2023
13 checks passed
@RunDevelopment RunDevelopment deleted the docs-impr-2 branch July 2, 2023 19:23
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.

None yet

2 participants