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

docs: Add direct link to binding documentations in README.md. #364

Open
duesee opened this issue Feb 20, 2023 · 3 comments
Open

docs: Add direct link to binding documentations in README.md. #364

duesee opened this issue Feb 20, 2023 · 3 comments
Labels
documentation 🗒 Improvements or additions to documentation

Comments

@duesee
Copy link
Contributor

duesee commented Feb 20, 2023

No description provided.

@duesee duesee added the documentation 🗒 Improvements or additions to documentation label Feb 20, 2023
@github-project-automation github-project-automation bot moved this to Triage Needed in HACL Packages Feb 20, 2023
@ma-ilsi
Copy link
Contributor

ma-ilsi commented Sep 27, 2023

By "binding" you mean generating the docs? In that case, can we just add small section in README.md with the commands needed to build the docs, instead of a link to another place to get those commands:

# Install the dependencies for documentation generation
$ pip install -r docs/reference/requirements.txt
# Generate
$ ./mach doc

@duesee
Copy link
Contributor Author

duesee commented Sep 27, 2023

What I meant when I opened this issue was that it's currently a rather "long way" to get to the C documentation. It's GitHub/Link in "About" section/"C" in Getting Started/Reference. 4 clicks. I thought there should be a direct link to the C bindings in the README (but I'm not involved with this project anymore and would propose you wait for an answer from a maintainer.) Thanks for improving the RSA examples, by the way. I was happy to see someone tackled it :-)

@ma-ilsi
Copy link
Contributor

ma-ilsi commented Sep 27, 2023

it's currently a rather "long way" to get to the C documentation. It's GitHub/Link in "About" section/"C" in Getting Started/Reference. 4 clicks.

Haha, yes I remember my first experience to get to the documentation, it is a multi-click process. After that, you get the handle on how to navigate around.

Thanks for improving the RSA examples, by the way. I was happy to see someone tackled it

You're welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 🗒 Improvements or additions to documentation
Projects
Status: Triage Needed
Development

No branches or pull requests

2 participants