Skip to content

Conversation

@JacksonEi
Copy link

PR Description

Overview

This PR includes updates to the adr-001-repo.md documentation file within the docs/architecture directory. The changes are aimed at aligning the lite client specifications with the latest Tendermint documentation and preparing for a TLA+ implementation.

Changes

  • Added a new section that emphasizes the importance of closely following the lite client spec and working in parallel on a TLA+ implementation.
  • Added a note regarding the signers(commit) function, clarifying that while the spec assumes this function returns validators for a given commit, in practice, the validator set itself is not included in the commit.

Verification

  • Referenced an issue explaining the need for the change
    • This PR addresses the need to update our documentation to align with the latest Tendermint lite client specifications and to prepare for a TLA+ implementation. An associated issue has been filed and is referenced here.
  • Updated all relevant documentation in docs
    • The adr-001-repo.md file within the docs/architecture directory has been updated to reflect the latest specifications and implementation plans.
  • Updated all code comments where relevant
    • No code comments were relevant to the changes made in this PR.
  • Wrote tests
    • No new tests were required as this PR only updates documentation.
  • Added entry in .changelog/
    • An entry has been added to the .changelog/ directory to document this update.

Additional Notes

  • Please review the changes and ensure they meet the project's standards.
  • If additional documentation updates are necessary, please suggest them in the comments.

PR Checklist

  • This PR is ready to be merged.
  • The title of this PR follows the conventional commits standard.
  • All changes have been tested locally.

Thank you for reviewing this PR. If you have any questions or require further information, please let me know.

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

Successfully merging this pull request may close these issues.

1 participant