dfinity / dfinity/candid

As a USER, I want to see a link to the GitHub repo so that I can look at the code

Open
#520 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
301
Forks
85
Avg merge
1h 4m
Merged PRs (30d)
4

Description

I maintain an api-reference canister for icpp-pro (C++ CDK):
Try it out in Candid UI

  • The API Reference example code can be found in a Github repo icpp-demos
  • The API Reference is also covered in the docs: API Reference

My feature request
As a user, when I am trying it out in Candid UI, and I find an API that is exactly what I am looking for, I want to see links to the underlying code and the related documentation. It is all about discoverability of the important information and not losing time searching for it.

Describe the solution you'd like

  • As a developer of canisters, I would like to be able to include metadata in the custom section of the wasm file that is picked up by Candid UI and displayed to the User. I would like to be able to add:
    • Link to GitHub
    • Link to documentation

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with Candid UI's handling of Wasm custom sections and the API Reference canister described in the issue. Determine how GitHub and documentation links should be encoded and displayed when a user finds an API, then verify that both links are discoverable from the Candid UI.

Written by the indexing model from the issue text.

Assessment

Tech stack
wasm
Domain
api, devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.