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

feat: Final docs pass #49

Merged
merged 15 commits into from
Jun 24, 2024
Merged

feat: Final docs pass #49

merged 15 commits into from
Jun 24, 2024

Conversation

wwared
Copy link
Member

@wwared wwared commented Jun 24, 2024 •
edited
Loading

  • Add security.md page
  • Update all the bench commands
  • Combine all the benchmarking variables (RUSTFLAGS etc) to be equal
  • Pin toolchain to nightly-2024-05-31 (current nightly is unfortunately not working for the LC)
  • Minor fixes to proof_server.rs
  • General minor changes over all the docs
  • Fix to the tag-release.yml workflow (further fixes such as argumentcomputer/sphinx@b3d62f0 coming in a follow-up PR)
  • Update plonk fixtures to the latest version of the RISC-V programs
  • Updates the static data used for the e2e bench (fix: update static aptos data #50)

This PR is probably enough to close #14

@wwared
feat: Final docs pass
dad1612 
- Add security.md page
- Update all the bench commands
- Combine all the benchmarking variables (RUSTFLAGS etc) to be equal
- Pin toolchain to nightly-2024-05-31 (current nightly is unfortunately
not working for the LC)
- Minor fixes to proof_server.rs
- General minor changes over all the docs
wwared
wwared commented Jun 24, 2024
View reviewed changes
aptos/docs/src/benchmark/proof.md Outdated Show resolved Hide resolved
aptos/docs/src/design/edge_cases.md Outdated Show resolved Hide resolved
aptos/docs/src/run/configuration.md Outdated Show resolved Hide resolved
aptos/docs/src/run/setup_aptos_pfn.md Outdated Show resolved Hide resolved
aptos/proof-server/benches/proof_server.rs Outdated Show resolved Hide resolved
tchataigner
tchataigner reviewed Jun 24, 2024
View reviewed changes
aptos/docs/src/benchmark/proof.md Outdated Show resolved Hide resolved
aptos/docs/src/benchmark/proof.md Outdated Show resolved Hide resolved
aptos/docs/src/benchmark/proof.md Outdated Show resolved Hide resolved
aptos/docs/src/benchmark/proof.md Outdated Show resolved Hide resolved
aptos/docs/src/components/proof_server.md Outdated Show resolved Hide resolved
aptos/docs/src/components/proof_server.md Outdated Show resolved Hide resolved
storojs72
storojs72 previously approved these changes Jun 24, 2024
View reviewed changes
Copy link
Member

@storojs72 storojs72 left a comment

Choose a reason for hiding this comment

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

LGTM. If some comments look arguable, the final resolution is up to you

aptos/core/README.md Show resolved Hide resolved
aptos/docs/src/benchmark/e2e.md Outdated Show resolved Hide resolved
aptos/docs/src/components/proof_server.md Outdated Show resolved Hide resolved
aptos/docs/src/design/edge_cases.md Show resolved Hide resolved
aptos/docs/src/design/epoch_change_proof.md Outdated Show resolved Hide resolved
aptos/docs/src/design/security.md Outdated Show resolved Hide resolved
aptos/docs/src/design/security.md Outdated Show resolved Hide resolved
aptos/proof-server/benches/proof_server.rs Outdated Show resolved Hide resolved
@wwared wwared mentioned this pull request Jun 24, 2024
Open
@wwared
fix: Properly swap the bench RUN_PARALLEL blocks
fee574b
@wwared
fix: Update proof_server.rs bench, add times
7212d89 
Remove RUST_LOG from the proof_server bench. The plonky3 and other logs
cause a loss of parallelism due to the stdout mutex, leading to a
performance regression with it on.
storojs72
storojs72 approved these changes Jun 24, 2024
View reviewed changes
Copy link
Member

@storojs72 storojs72 left a comment

Choose a reason for hiding this comment

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

LGTM

@wwared wwared enabled auto-merge (squash) June 24, 2024 23:20
@wwared wwared merged commit a0c79c1 into dev Jun 24, 2024
4 checks passed
@tchataigner tchataigner deleted the wwared/docs branch June 24, 2024 23:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tchataigner tchataigner tchataigner approved these changes

@storojs72 storojs72 storojs72 approved these changes

@huitseeker huitseeker Awaiting requested review from huitseeker

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Edit, Complete and Refactor Documentation according to 3 "user stories"
3 participants
@wwared @tchataigner @storojs72