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

Improve docs.rs documentation #1158

Open
brockelmore opened this issue Feb 5, 2023 · 2 comments
Open

Improve docs.rs documentation #1158

brockelmore opened this issue Feb 5, 2023 · 2 comments
Labels
chore enhancement New feature or request help wanted Extra attention is needed

Comments

@brockelmore
Copy link

Describe the bug
Currently, documentation is a read-the-docs style documentation. This kinda sucks for consumers of this as a library (i.e. Foundry, etc) because rust devs are used to docs.rs style. Forcing users to clone the repo and run cargo doc --open is less than ideal

To Reproduce
Steps to reproduce the behavior:

  1. go to the documentation site

Expected behavior
Alternatively or additionally publish docs to docs.rs

Screenshots
N/A

Hyperledger Solang version
N/A

Include the complete solidity source code
N/A

Additional context
N/A

@xermicus
Copy link
Contributor

xermicus commented Feb 6, 2023

We do not link to it on crates.io, but that doesn't mean it is not on docs.rs.

However, please keep in mind, providing a stable and well-documented API for 3rd-party projects (except for our solang-parser lib) is currently work in progress.

@seanyoung seanyoung added the enhancement New feature or request label Feb 9, 2023
@seanyoung
Copy link
Contributor

The rustdoc is very incomplete. The solang crate does not have any crate level documentation, nor does solang-parser. This can certainly be improved. There are many functions, enums and structs which do not have documentation. The solang-parser crate does not have a README.md either, which looks bad on crates.io.

The rustdoc should describe how solang can be used as a crate. The documentation for the solidity language does not belong in the rust doc, but it certainly must be linked from rustdoc.

This issue should cover improving the overall rustdoc experience, without merging the readthedocs documentation. There is a clear separation between the solidity language and the using the compiler crate.

@seanyoung seanyoung added help wanted Extra attention is needed chore labels Feb 9, 2023
@seanyoung seanyoung changed the title Publish docs.rs documentation Improve docs.rs documentation Feb 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants