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(frontend): update new structure and landing page #735

Merged
merged 1 commit into from
Mar 11, 2024
Merged

Conversation

yuxizama
Copy link
Contributor

@yuxizama yuxizama commented Mar 8, 2024

  • Add a landing page
  • Reorganize existing docs
  • Add new designs

@cla-bot cla-bot bot added the cla-signed label Mar 8, 2024
@bcm-at-zama
Copy link
Contributor

I'll have a look on monday

@bcm-at-zama
Copy link
Contributor

bcm-at-zama commented Mar 8, 2024

D docs/application-tutorial/key_value_database.md (3)
D docs/application-tutorial/sha256.md (3)

looks strange. I'm afraid you deleted the files. I guess it was not the intention, we can resurrect them

EDIT: my bad, it's ok, @yuxizama just removed the .md, not the sources so ok

@bcm-at-zama
Copy link
Contributor

Fixing conflicts

@bcm-at-zama
Copy link
Contributor

I need to fix the build.

@bcm-at-zama
Copy link
Contributor

Lot of broken links to fail: I'm on it

@yuxizama
Copy link
Contributor Author

FILE: ./docs/SUMMARY.md
[✖] explanations/compilation/FHELinalgDialect.md → Status: 400
Change link from explanations/compilation/FHELinalgDialect.md to docs/explanations/FHELinalgDialect.md
[✖] explanations/TFHEDialect.md
Move doc to: docs/explanations/TFHEDialect

FILE: ./docs/explanations/dialects.md
[✖] TFHEDialect.md → Status: 400
same as above, need to move this file to docs/explanations/TFHEDialect
[✖] ../../_static/compilation-pipeline/compilation-flow.png → Status: 400
Change link from /github/workspace/_static/compilation-pipeline/compilation-flow.png to docs/_static/compilation-pipeline/compilation-flow.png

FILE: ./docs/explanations/optimizer.md
[✖] ../security/security_curves.md → Status: 400
Change link from /github/workspace/docs/security/security_curves.md to docs/dev/security/security_curves.md
[✖] ../../../compilers/concrete-optimizer/v0-parameters/ref/v0_last_128 → Status: 400
Change link from /github/compilers/concrete-optimizer/v0-parameters/ref/v0_last_128 to compilers/concrete-optimizer/v0-parameters/ref/v0_last_128
[✖] ../../../compilers/concrete-optimizer/v0-parameters/README.md → Status: 400
Change link from /github/compilers/concrete-optimizer/v0-parameters/README.md to compilers/concrete-optimizer/v0-parameters/README.md

FILE: ./docs/get-started/quick_start.md
[✖] ../tutorial/extensions.md#fheinputset → Status: 400
The H2 has been changed in the file to /tutorial/extensions.md#fheunivariatefunction

FILE: ./docs/dev/compilation/README.md
[✖] ../fusing.md → Status: 400
change link from /github/workspace/docs/dev/fusing.md to docs/dev/fusing.md

@yuxizama
Copy link
Contributor Author

FILE: ./docs/core-features/extensions.md
[✖] ../_static/tutorials/relu/configuration_and_cost.png → Status: 400
Change link from /github/workspace/docs/_static/tutorials/relu/configuration/_and/_cost.png to docs/_static/tutorials/relu/configuration_and_cost.png

FILE: ./frontends/concrete-python/examples/xor_distance/xor_distance.md
[✖] ../../frontends/concrete-python/examples/xor_distance/hamming_distance.py → Status: 400
Change link from /github/workspace/frontends/concrete-python/frontends/concrete-python/examples/xor_distance/hamming_distance.py to frontends/concrete-python/examples/xor_distance/hamming_distance.py

FILE: ./frontends/concrete-python/examples/game_of_life/game_of_life.md
[✖] ../_static/game-of-life.gif → Status: 400
Change link from /github/workspace/frontends/concrete-python/examples/_static/game-of-life.gif to docs/_static/game-of-life.gif

Copy link
Contributor

@bcm-at-zama bcm-at-zama left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@bcm-at-zama bcm-at-zama merged commit a0195cf into main Mar 11, 2024
23 of 25 checks passed
@bcm-at-zama
Copy link
Contributor

Thx @yuxizama !

@yuxizama yuxizama deleted the docs-revamp branch March 12, 2024 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants