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

feat: docs for Flow protocol #189

Merged
merged 11 commits into from
Oct 23, 2024
Merged

Conversation

smol-ninja
Copy link
Member

@smol-ninja smol-ninja commented Oct 14, 2024

Built on top of #186, this PR deals with content for Flow protocol.

  • Adds autogen-flow script and renames lockup's autogen script to autogen-lockup
  • Adds flow submodule
  • Refactors NFT page with a new content layout
  • Adds Flow statuses
  • Adds flow contracts guide
  • Flow governance
  • Flow fees
  • Flow audits
  • Flow developer guides
  • Flow custom deployment
  • Flow errors
  • Flow access control
  • Use package versioning when referring to lockups
  • Refactor V1 to v1 (legacy)

refactor: rename autogen to autogen-lockup
@smol-ninja smol-ninja marked this pull request as draft October 15, 2024 11:55
refactor: rename v1 to v1 legacy
feat: add benchmark, deployments, errors, access control for flow
refactor: rename guides folders to examples
@smol-ninja smol-ninja changed the title [wip] feat: docs for Flow protocol feat: docs for Flow protocol Oct 18, 2024
@smol-ninja
Copy link
Member Author

smol-ninja commented Oct 18, 2024

This PR can be reviewed now. The deployment can be found here. There are a few pages that will be updated over time such as

  • audits (haven't received Cantina URL)
  • diagrams (need to think a good way to organize them)
  • glossary (still thinking of a good way to aggregate both Flow and lockup definitions on a single page)
  • flow examples (requires updating examples repo first)

If everything looks good, I will merge it into #186 which will be merged before the launch.

polishing references to legacy protocol
@smol-ninja
Copy link
Member Author

smol-ninja commented Oct 23, 2024

I am merging this PR into #186 so that we can review everything in one PR now.

@smol-ninja smol-ninja merged commit 28aa4ea into docs/flow-protocol Oct 23, 2024
1 check was pending
@smol-ninja smol-ninja deleted the docs/flow-content branch October 23, 2024 14:07
smol-ninja added a commit that referenced this pull request Oct 23, 2024
* feat: autogen script for Flow
refactor: rename autogen to autogen-lockup

* fix hyperlink issue

* flow status and nft

* flow fees and governance

* refactor: use package versioning when referring to lockups
refactor: rename v1 to v1 legacy
feat: add benchmark, deployments, errors, access control for flow

* update diagrams placeholde

* Flow custom deployments

* feat: flow diagrams
refactor: rename guides folders to examples

* adds link to flow audits
polishing references to legacy protocol

* update flow references

* rename previous versions to previous deployments
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