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

ScaFi documentation site could be improved #62

Open
cric96 opened this issue Jan 18, 2022 · 2 comments
Open

ScaFi documentation site could be improved #62

cric96 opened this issue Jan 18, 2022 · 2 comments

Comments

@cric96
Copy link
Collaborator

cric96 commented Jan 18, 2022

The ScaFi documentation contains different parts that are not currently written (the meaning of BlockG, BlockC, ...).
Furthermore, the documentation structure could be confusing for the beginner. We can consider using a conceptual framework to rewrite the documentation (e.g. trivio).
Also, a better page structure could help (as this one).

@metaphori
Copy link
Contributor

metaphori commented Jun 21, 2022

Moreover, we should also handle version-specific documentation, and ensure that documentation properly reflects the currently considered ScaFi version.

@DanySK
Copy link
Collaborator

DanySK commented Jun 21, 2022

This has been done already for Alchemist. It can be replicated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants