Skip to content

Comments

docs: small revision to the documentation#512

Merged
mergify[bot] merged 4 commits intosigp:unstablefrom
chong-he:book
Aug 19, 2025
Merged

docs: small revision to the documentation#512
mergify[bot] merged 4 commits intosigp:unstablefrom
chong-he:book

Conversation

@chong-he
Copy link
Member

Small revision to the docs:

  • remove all instances of anchor-book in this repo (as they are no longer a valid link)
  • add a toggle to switch to light theme - because the figure in Architecture (the arrows) can't be seen in dark theme
  • remove what-is-ssv page as I think it is a bit of overlapping and the content is not really necessary (I move some of it to introduction), feel free to revert if this is not ok

I didn't add a guide to run Anchor as I think the current Running an Operator is sufficient. I think there is no need to add a guide for stakers part of it, as stakers will most probably not use Anchor (as they will likely delegate to operators to run the node, as noted by @dknopik)

@cla-assistant
Copy link

cla-assistant bot commented Aug 18, 2025

CLA assistant check
All committers have signed the CLA.

@cla-assistant
Copy link

cla-assistant bot commented Aug 18, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@chong-he chong-he changed the title Small revision to the documentation docs: small revision to the documentation Aug 18, 2025
@chong-he chong-he added documentation Improvements or additions to documentation ready-for-review This PR is ready to be reviewed labels Aug 18, 2025
Copy link
Member

@dknopik dknopik left a comment

Choose a reason for hiding this comment

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

Awesome, thanks! Some minor nitpicks:

</div>
<div className="stat-item">
<div className="stat-number">12</div>
<div className="stat-number">13</div>
Copy link
Member

Choose a reason for hiding this comment

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

This is automatically updated on push


Anchor will look for the key file inside the directory specific by `--datadir`, unless you
specify it via `--key-file`.
Anchor will look for the key file in the default directory `~/.anchor/{network`, or the directory specified by `--datadir`. No newline at end of file
Copy link
Member

Choose a reason for hiding this comment

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

Missing closing brace

Need Help?
- Check our [FAQ](/faq) for common questions
- Join the community on [GitHub](https://github.com/sigp/anchor)
- Join the community on [Discord] (https://discord.com/invite/cyAszAh)
Copy link
Member

Choose a reason for hiding this comment

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

remove space between Discord und link

@chong-he
Copy link
Member Author

Awesome, thanks! Some minor nitpicks:

Thanks for the detailed review. All revised in e1d5c70

Copy link
Member

@dknopik dknopik left a comment

Choose a reason for hiding this comment

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

LGTM, thanks CK!

@dknopik dknopik added ready-for-merge and removed ready-for-review This PR is ready to be reviewed labels Aug 19, 2025
mergify bot added a commit that referenced this pull request Aug 19, 2025
@mergify mergify bot merged commit 1be53b2 into sigp:unstable Aug 19, 2025
18 checks passed
diegomrsantos pushed a commit to diegomrsantos/anchor that referenced this pull request Aug 26, 2025
Zacholme7 pushed a commit to Zacholme7/anchor that referenced this pull request Aug 27, 2025
petarjuki7 pushed a commit to petarjuki7/anchor that referenced this pull request Sep 6, 2025
@chong-he chong-he deleted the book branch November 7, 2025 03:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ready-for-merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants