Skip to content

Fix typos and improve documentation#16422

Closed
Dimitrolito wants to merge 445 commits intoMinaProtocol:compatiblefrom
Dimitrolito:fix/typos
Closed

Fix typos and improve documentation#16422
Dimitrolito wants to merge 445 commits intoMinaProtocol:compatiblefrom
Dimitrolito:fix/typos

Conversation

@Dimitrolito
Copy link
Copy Markdown

@Dimitrolito Dimitrolito commented Dec 15, 2024

This pull request fixes several typographical errors and improves the documentation in the following files:

  • README.md
  • 0016-transition-frontier-persistence.md
  • 0020-transition-frontier-extensions-2.md

Changes:

  • Fixed the use of "a" vs. "an" in README.md.
  • Added missing hyphens in compound adjectives like "non-optimal" and "user-friendly".
  • Corrected grammatical errors in the explanation of the transition frontier persistence and extension processes.
  • Enhanced readability and consistency in the documentation.

Testing:

  • No changes to functionality were made, so no new tests are required. CI will verify that all existing tests pass.

Checklist:

  • Dependency versions are unchanged
  • Modified the current draft of release notes with details on what is completed or incomplete within this project
  • Documented code purpose and usage
  • All tests pass (CI will check this if you didn't)
  • Closes issues: None

dkijania and others added 30 commits September 18, 2024 10:15
@dkijania
Dhall lints
afe43a7
@dkijania
Merge branch 'develop' into dkijania/fix_debian_name_logic
d15a406
@dkijania
Merge pull request #16062 from MinaProtocol/dkijania/fix_debian_name_…
5b8924f 
…logic

Fix debian branch name logic dev
@dkijania
Merge branch 'develop' into dkijania/port_compatible_berkeley_removal
513ac11
@dkijania
Merge branch 'develop' into dkijania/revive_extract_dump_archive_test…
b756da7 
…_dev
@dkijania
Merge branch 'compatible' into dkijania/revive_extract_dump_archive_test
110c5f4
@dkijania
Revert "Auxiliary commit to revert individual files from b756da7"
ead07b9 
This reverts commit 091ddca79ae8e939d4065d9f195bd075898704e5, reversing
changes made to b5d2546.
@dkijania
pass BRANCH_NAME to export-git-env-vars script properly
3a04375
@dkijania
Merge branch 'compatible' into dkijania/revive_extract_dump_archive_test
098b05c
@dkijania
Merge pull request #16087 from MinaProtocol/dkijania/remove_HEAD_once…
d55f0df 
…_for_all

pass BRANCH_NAME to export-git-env-vars script properly
@dkijania
Merge branch 'develop' into dkijania/revive_extract_dump_archive_test…
9927f77 
…_dev
@dkijania
Merge branch 'develop' into dkijania/port_compatible_berkeley_removal
19236f2
@mrmr1993
Merge branch 'develop' into merge-back-to-develop-2024-09-19
a29d6dd
@dkijania
Merge pull request #15989 from MinaProtocol/dkijania/revive_extract_d…
e9d723d 
…ump_archive_test_dev

Port patch archive test to dev
@dkijania
fix step name for functional test suite
b806cb9
@dkijania
Merge branch 'compatible' into dkijania/revive_extract_dump_archive_test
d0142a8
@dkijania
Update main Readme
421e95f
@dkijania
Merge branch 'dkijania/remove_leaderboard' into dkijania/port_removin…
ed93733 
…g_leaderboard_dev
@mrmr1993
Merge pull request #16090 from MinaProtocol/merge-back-to-develop-202…
fb1c3c0 
…4-09-19

Merge back to develop
@dkijania
Merge branch 'develop' into dkijania/update_logo_dev
3f6c08d
@dkijania
Merge branch 'develop' into dkijania/port_removing_leaderboard_dev
65793bc
@dkijania
Merge branch 'develop' into dkijania/port_compatible_berkeley_removal
7568721
@dkijania
fix PatchArchiveTest usage of network arg
6a37077
@dkijania
revert docker path + replace TAG with NEW_VERSION
11fbd9c
@dkijania
Fix archive proof mismatch between compiled nad runtime config
72a4b0e
@dkijania
Merge branch 'compatible' into dkijania/revive_extract_dump_archive_test
a5adde1
@dkijania
Merge branch 'compatible' into dkijania/revive_extract_dump_archive_test
a90041a
@dkijania
Merge branch 'dkijania/revive_extract_dump_archive_test' into dkijani…
02a9f79 
…a/port_patch_archive_test_dev
@dkijania
Merge pull request #16097 from MinaProtocol/dkijania/port_removing_le…
2c77413 
…aderboard_dev

[DEV] Remove Leaderboard project
@dkijania
Merge branch 'develop' into dkijania/port_patch_archive_test_dev
d4b8008
leopardracer and others added 22 commits December 1, 2024 19:39
@leopardracer
Update README-dev.md
53a71eb
@svv232
Merge pull request #16393 from leopardracer/patch-1
82642cc 
fix: typos in documentation files
@dkijania
Merge pull request #16389 from MinaProtocol/dkijania/dkijania/sign_ap…
86135da 
…t_debians_dev

[dev] add optional debians sign
@dkijania
fix docker tag and exit on error
7b68eec 
fix cleanup method name
fix rosetta-connectivity.sh name
increase timeout for rosetta connectivity test
add connectivity tests
export postgres variables in docker-start.sh
use single-run option for missing-block-guardian
us mina missing block guardian script
@dkijania
fix rosetta script
56c2131
@dkijania
fix match_count increment
d298b89
@dkijania
fix loop which listens for docker logs
f0315c2
@dkijania
increase wait timeout for next line in docker output
c6ba182
@dkijania
increase timeout for mainnet
7f56486
@dkijania
increase timeout event more
a86081a
@dkijania
increase timeout
5e1f781
@dkijania
Merge branch 'dkijania/rosetta_start_issue' into dkijania/rosetta_sta…
761a5cd 
…rt_issue_dev
@dkijania
run connectivity tests only in stable pipelines
de9a50b
@dkijania
Merge pull request #16390 from MinaProtocol/dkijania/rosetta_start_is…
542ee96 
…sue_dev

port rosetta docker-start fix and test to dev
@dkijania
Merge branch 'dkijania/rosetta_start_issue' into dkijania/port_rosett…
0593291 
…a_start_issue_again
@dkijania
Merge pull request #16407 from MinaProtocol/dkijania/port_rosetta_sta…
4b1c61e 
…rt_issue_again

[dev] Run rosetta connectivity in stable pipelines
@Dimitrolito
typos README.md
e345d12
@Dimitrolito
typos README.md
a50025e
@Dimitrolito
typos README.md
f6b1a21
@Dimitrolito
typos 0016-transition-frontier-persistence.md
84512ce
@Dimitrolito
typos 0016-transition-frontier-persistence.md
1dd81fd
@Dimitrolito
typos 0020-transition-frontier-extensions-2.md
168177c
@Dimitrolito Dimitrolito requested a review from a team as a code owner December 15, 2024 13:27
@dannywillems
Copy link
Copy Markdown
Member

dannywillems commented Dec 16, 2024

Can you do it on compatible instead, please?

@Dimitrolito Dimitrolito changed the base branch from develop to compatible December 16, 2024 13:12
@Dimitrolito Dimitrolito requested review from a team as code owners December 16, 2024 13:12
@Dimitrolito
Copy link
Copy Markdown
Author

Dimitrolito commented Dec 16, 2024

@dannywillems

Sure, I've moved it to the compatible branch instead

@Dimitrolito
Copy link
Copy Markdown
Author

Dimitrolito commented Jan 7, 2025

Hi @dannywillems

Just a reminder about pull request #16422, which has been approved but has not been merged yet. It fixes several typos and improves the documentation in the following files:

  • README.md
  • 0016-transition-frontier-persistence.md
  • 0020-transition-frontier-extensions-2.md

I’d appreciate it if you could merge it when you get the chance. Thank you!

@mrmr1993 mrmr1993 closed this Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@Dimitrolito @dannywillems @mrmr1993 @dkijania @martyall @SanabriaRusso @georgeee @leopardracer @svv232