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

Refactoring Sygma docs #136

Merged
merged 58 commits into from
May 30, 2024
Merged

Refactoring Sygma docs #136

merged 58 commits into from
May 30, 2024

Conversation

haochizzle
Copy link
Collaborator

@haochizzle haochizzle commented Mar 26, 2024

refactor:

  • larger restructure for docs to add sections for devs, for users, for cross-chain apps, relayers etc.
  • add tailored security documentation
  • add relevant details for how relayers work under spectre vs zipline verification
  • add documentation for tailored security - selection mechanism
  • add documentation for btc
  • add documentation for cross-chain app multichain-deploy
  • add documentation for widget
  • add documentation for validator-app

chores:

  • update github repositories to include new repos
  • update audits page to include veridise report
  • update FAQs to include tailored security resources
  • update examples to use cronos testnet where applicable
  • update video resources to include new substrate workshop
  • remove testnet faucet links (e.g. resources->official links page)
  • update glossary to include terms related to tailored security
  • update dictionary

closes:[#134][#142]

@haochizzle haochizzle self-assigned this Mar 26, 2024
@haochizzle haochizzle marked this pull request as ready for review May 27, 2024 17:29
Copy link
Contributor

@MakMuftic MakMuftic left a comment

Choose a reason for hiding this comment

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

Minor remarks:

  • we should add a widget URL on the landing page (What's Next)
  • on the /protocol page first, arh. diagram should be centered IMO
  • Not sure do we need Using The Sygma UI Widget as we have a dedicated widget part in Integrating With Sygma

@haochizzle haochizzle enabled auto-merge (squash) May 30, 2024 16:32
@haochizzle haochizzle merged commit 5424d72 into develop May 30, 2024
1 check passed
@haochizzle haochizzle deleted the tho/docsrefactor branch May 30, 2024 16:56
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.

3 participants