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.

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

docs: symbiotic revision #231

Merged
merged 49 commits into from
Mar 10, 2025
Merged

docs: symbiotic revision #231

merged 49 commits into from
Mar 10, 2025

Conversation

ernestosperanza
Copy link
Contributor

@ernestosperanza ernestosperanza commented Feb 10, 2025

Description

  • Correct some concepts that were a little bit off regarding symbiotic
  • Explain how the reward system works
  • Explain the slashing system
  • Explain the burner contract role

Checklist

  • I have added a label to this PR 🏷️
  • I have run my changes through Grammarly
  • If this page requires a disclaimer, I have added one
  • If pages have been moved around, I have created an additional PR in tanssi-mkdocs to update redirects

@ernestosperanza ernestosperanza self-assigned this Feb 10, 2025
@ernestosperanza ernestosperanza added the B0 - Needs Review Pull request is ready for review label Feb 10, 2025
Copy link
Contributor

@augustocollado augustocollado left a comment

Choose a reason for hiding this comment

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

Good starting point!
There are parts that I find a bit hard to understand, in general, learn section should be easy as a first approach, and if necessary, link other sections that go deeper.

@ernestosperanza ernestosperanza marked this pull request as ready for review February 13, 2025 18:38
@ernestosperanza ernestosperanza requested a review from a team as a code owner February 13, 2025 18:38
Copy link
Contributor

@augustocollado augustocollado left a comment

Choose a reason for hiding this comment

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

Excellent work with the diagrams!

Copy link
Contributor

@augustocollado augustocollado left a comment

Choose a reason for hiding this comment

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

Almost there!

augustocollado
augustocollado previously approved these changes Feb 20, 2025
Copy link
Contributor

@augustocollado augustocollado left a comment

Choose a reason for hiding this comment

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

LGTM!

@ernestosperanza
Copy link
Contributor Author

@eshaben Thanks for your input. I tried to cover all your comments; let me know if I missed anything.
Related to the diagrams, I also think that the color palette can be misleading sometimes. I tried to modify some elements, but I couldn't.

There is some problem in the way that Mermaid renders the diagram when it is integrated with mkdocs.
The best thing that I could do was modify the background of the diagrams so that they are easier to understand.

This are some examples:
Screenshot 2025-03-06 at 5 44 12 PM
Screenshot 2025-03-06 at 5 44 27 PM
Screenshot 2025-03-06 at 5 44 35 PM

And this is the PR with the background chance

augustocollado
augustocollado previously approved these changes Mar 10, 2025
Copy link
Contributor

@augustocollado augustocollado left a comment

Choose a reason for hiding this comment

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

LGTM!

@ernestosperanza ernestosperanza requested a review from eshaben March 10, 2025 21:41
Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

LGTM! 🚢

@eshaben eshaben added B1 - Ready to Merge Pull request is ready to be merged and removed B0 - Needs Review Pull request is ready for review labels Mar 10, 2025
@eshaben
Copy link
Contributor

eshaben commented Mar 10, 2025

Going to merge this now to avoid merge any possible merge conflicts (Just in case. I know there's another PR that edits this page)

@eshaben eshaben merged commit 677416b into main Mar 10, 2025
2 checks passed
@eshaben eshaben deleted the ernest/symbiotic branch March 10, 2025 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.) B1 - Ready to Merge Pull request is ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants