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

Developer can read documentation for Candid #144

Closed
rossberg opened this issue Dec 2, 2020 · 4 comments · Fixed by #158
Closed

Developer can read documentation for Candid #144

rossberg opened this issue Dec 2, 2020 · 4 comments · Fixed by #158
Assignees
Labels
5pts Documentation Improvements or additions to documentation Story

Comments

@rossberg
Copy link
Contributor

rossberg commented Dec 2, 2020

We keep getting user questions about Candid, e.g., about its syntax. But all documentation we currently have is the "spec", which is not really targeted at users and is overly technical.

We should have some primary "user guide" that is accessible for programmers, not implementers.

@rossberg rossberg added the Documentation Improvements or additions to documentation label Dec 2, 2020
@kritzcreek
Copy link

Might be worth checking out: https://docs.dhall-lang.org

The first section is "Discussions", which is dedicated to motivating "yet another configuration language" which is something we'll also have to prioritize.

@lsgunnlsgunn
Copy link
Contributor

We do actually have some doc about Candid syntax, but at the moment it is buried inside of the command-line reference section (I know it is minimal and possibly out of date since I haven't revisited it much in the last year--see https://sdk.dfinity.org/docs/developers-guide/cli-reference/dfx-canister.html under Interface description syntax for arguments). It was called IDL at the time, but that might be part of the reason it is hard for people to find
At some point, I'd like to be able to build out more user-facing info and examples for Candid and add something more user-friendly to help people create Candid files by hand to support other languages.

@ghost ghost assigned nomeata Jan 5, 2021
@ghost ghost changed the title User-facing documentation Developer can read documentation for Candid Jan 6, 2021
@ghost ghost added the Story label Jan 6, 2021
@ghost
Copy link

ghost commented Jan 6, 2021

@nomeata do you have an estimate for this story?

@nomeata
Copy link
Collaborator

nomeata commented Jan 7, 2021

@nomeata do you have an estimate for this story?

Documentation is always open ended… I hoped to have something that can already be shown publicly by end of this week… but now other tasks were added… so maybe end of next week

nomeata added a commit that referenced this issue Jan 7, 2021
this is the beginning of a user-facing, user-friendly guide.

Fixes #144.
@ghost ghost added the 5pts label Jan 19, 2021
nomeata added a commit that referenced this issue Jan 19, 2021
this is the beginning of a user-facing, user-friendly guide.

Fixes #144.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5pts Documentation Improvements or additions to documentation Story
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants