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.

Sign up for GitHub

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

Jump to bottom

Alba Documentation #51

Open
5 of 10 tasks
rrtoledo opened this issue Nov 1, 2024 · 0 comments
Open
5 of 10 tasks

Alba Documentation #51

rrtoledo opened this issue Nov 1, 2024 · 0 comments
Assignees
@curiecrypt
Labels
documentation Improvements or additions to documentation

Comments

@rrtoledo
Copy link
Collaborator

rrtoledo commented Nov 1, 2024 •
edited by curiecrypt
Loading

Why

To give more in-depth information about Alba, and how this implementation relates to the paper.

What

Implement comprehensive documentation for the Alba project that we can compile through cargo doc command

Tasks
@rrtoledo rrtoledo added the documentation Improvements or additions to documentation label Nov 1, 2024
@rrtoledo rrtoledo linked a pull request Nov 6, 2024 that will close this issue
Cargo documentation for centralized version #34
Closed
9 tasks
@rrtoledo rrtoledo mentioned this issue Nov 6, 2024
Closed
9 tasks
@curiecrypt curiecrypt mentioned this issue Nov 6, 2024
Merged
8 tasks
curiecrypt added a commit that referenced this issue Nov 7, 2024
@curiecrypt
A generic structure for cargo documentation (#57)
6d56340 
## Content

This PR aims to create a generic structure for cargo documentation. The
content will be filled out by each section is implemented.


## Pre-submit checklist

- Branch
    - [X] Commit sequence broadly makes sense
    - [X] Key commits have useful messages
- PR
    - [X] No clippy warnings in the CI
    - [X] Self-reviewed the diff
    - [X] Useful pull request description
    - [X] Reviewer requested
- Documentation
    - [X] Update README file (if relevant)
    - [X] Update documentation website (if relevant)

## Comments
To compile the documentation run the following command:
```shell
RUSTDOCFLAGS="--html-in-header docs/assets/katex-header.html" cargo doc --no-deps --open
```
Note that `cargo clean` is sometimes required to see the changes.


## Issue(s)

Relates to #51 and Closes #56
This was referenced Nov 26, 2024
Closed
Closed
Closed
This was referenced Dec 10, 2024
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@curiecrypt curiecrypt

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Cargo documentation for centralized version cardano-scaling/alba
2 participants
@rrtoledo @curiecrypt