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

Enrich the doc so that Marmot looks more friendly to new user. #94

Merged
merged 16 commits into from
Dec 28, 2023
Merged

Enrich the doc so that Marmot looks more friendly to new user. #94

merged 16 commits into from
Dec 28, 2023

Commits on Dec 6, 2023

  1. Update dependencies to use mermaid

    @wongfei2009
    wongfei2009 committed Dec 6, 2023
    Configuration menu
    Copy the full SHA
    51b231e View commit details
    Browse the repository at this point in the history

  2. Add sequence diagram to show how Marmot works

    @wongfei2009
    wongfei2009 committed Dec 6, 2023
    Configuration menu
    Copy the full SHA
    b3c6185 View commit details
    Browse the repository at this point in the history

  3. Refine the sequence diagram

    @wongfei2009
    wongfei2009 committed Dec 6, 2023
    Configuration menu
    Copy the full SHA
    8421166 View commit details
    Browse the repository at this point in the history

  4. Add error scenarios

    @wongfei2009
    wongfei2009 committed Dec 6, 2023
    Configuration menu
    Copy the full SHA
    231bbf0 View commit details
    Browse the repository at this point in the history

  5. Tidy up the doc

    @wongfei2009
    wongfei2009 committed Dec 6, 2023
    Configuration menu
    Copy the full SHA
    5da5e64 View commit details
    Browse the repository at this point in the history

  6. Improve sequence diagram to illustrate restore

    @wongfei2009
    wongfei2009 committed Dec 6, 2023
    Configuration menu
    Copy the full SHA
    75a99b1 View commit details
    Browse the repository at this point in the history

  7. Add cli doc

    @wongfei2009
    wongfei2009 committed Dec 6, 2023
    Configuration menu
    Copy the full SHA
    cccfe91 View commit details
    Browse the repository at this point in the history

  8. Enrich the doc

    @wongfei2009
    wongfei2009 committed Dec 6, 2023
    Configuration menu
    Copy the full SHA
    9aef309 View commit details
    Browse the repository at this point in the history

  9. Minor tidy up

    @wongfei2009
    wongfei2009 committed Dec 6, 2023
    Configuration menu
    Copy the full SHA
    d987219 View commit details
    Browse the repository at this point in the history

Commits on Dec 7, 2023

  1. Fix typo

    @wongfei2009
    wongfei2009 committed Dec 7, 2023
    Configuration menu
    Copy the full SHA
    17901e8 View commit details
    Browse the repository at this point in the history

  2. Add changelog clean up

    @wongfei2009
    wongfei2009 committed Dec 7, 2023
    Configuration menu
    Copy the full SHA
    8d7691e View commit details
    Browse the repository at this point in the history

  3. Add Prometheus metrics doc

    @wongfei2009
    wongfei2009 committed Dec 7, 2023
    Configuration menu
    Copy the full SHA
    4cfd926 View commit details
    Browse the repository at this point in the history

Commits on Dec 8, 2023

  1. Update sample config file

    @wongfei2009
    wongfei2009 committed Dec 8, 2023
    Configuration menu
    Copy the full SHA
    2f81952 View commit details
    Browse the repository at this point in the history

  2. Update the example to have a symetric peers configuration

    @wongfei2009
    wongfei2009 committed Dec 8, 2023
    Configuration menu
    Copy the full SHA
    f168698 View commit details
    Browse the repository at this point in the history

  3. Add diagram for restoring snapshot

    @wongfei2009
    wongfei2009 committed Dec 8, 2023
    Configuration menu
    Copy the full SHA
    91e06ba View commit details
    Browse the repository at this point in the history

  4. Add more explanation on saving snapshot

    @wongfei2009
    wongfei2009 committed Dec 8, 2023
    Configuration menu
    Copy the full SHA
    f828923 View commit details
    Browse the repository at this point in the history