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

Documentation (#51) - Intro & Overview #60

Closed
curiecrypt opened this issue Nov 7, 2024 · 0 comments · Fixed by #62
Closed

Documentation (#51) - Intro & Overview #60

curiecrypt opened this issue Nov 7, 2024 · 0 comments · Fixed by #62
Assignees
@curiecrypt
Labels
documentation Improvements or additions to documentation
Milestone
Centralized scheme

Comments

@curiecrypt
Copy link
Collaborator

curiecrypt commented Nov 7, 2024 •
edited by rrtoledo
Loading

Why

An introductory level of documentation is needed.

What

  • README
  • Docs: Intro
  • Docs: Variable mapping

Linked to issue #51
@curiecrypt curiecrypt added the documentation Improvements or additions to documentation label Nov 7, 2024
@curiecrypt curiecrypt self-assigned this Nov 7, 2024
@curiecrypt curiecrypt mentioned this issue Nov 11, 2024
Merged
8 tasks
@rrtoledo rrtoledo mentioned this issue Nov 26, 2024
Open
11 tasks
@rrtoledo rrtoledo changed the title Documentation - Intro & Overview Documentation (https://github.com/cardano-scaling/alba/issues/51) - Intro & Overview Nov 26, 2024
@rrtoledo rrtoledo changed the title Documentation (https://github.com/cardano-scaling/alba/issues/51) - Intro & Overview Documentation (#51) - Intro & Overview Nov 26, 2024
@rrtoledo rrtoledo added this to the Centralised scheme milestone Nov 26, 2024
curiecrypt added a commit that referenced this issue Dec 2, 2024
@curiecrypt @rrtoledo @tolikzinovyev
Documentation - Intro (#62)
57a1c1e 
## Content

This PR aims to provide
- Introduction section of the documentation
- A page including the variable mapping
- README update

## 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
Run the following command to compile the documentation:
```shell
cargo doc --no-deps --open
```
Note that you might need to run `cargo clean` before compiling to see
the changes.

## Issue(s)
Closes #60

---------

Co-authored-by: Raphael <raphael.r.toledo@gmail.com>
Co-authored-by: Tolik Zinovyev <aszinovyev@gmail.com>
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
Centralized scheme
Development

Successfully merging a pull request may close this issue.

Documentation - Intro cardano-scaling/alba
2 participants
@rrtoledo @curiecrypt