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

Documentation - Cleanup documentation to be up-to-date with current state of Gnars #19

Open
bagelface opened this issue May 8, 2024 · 1 comment
Assignees
Labels
bounty Rewarded upon completion documentation Improvements or additions to documentation

Comments

@bagelface
Copy link
Contributor

Description 🗒️

Perform a full cleanup of the documentation so that it is up-to-date with current state of Gnars. The goal is to have a clean starting point from which to improve on the documentation.


Details 🏗️

  • Update outdated info if possible: Update outdated info in the documentation if possible. This includes links to contracts, references to Ethereum (vs Base), etc.
  • Remove outdated info otherwise: Information that cannot be updated because it references things that are longer being supported should be removed. This includes things like references to "The Gnarving" or "settle.wtf".
  • Fix any other issues: Fix any other issues with the documentation that you come across like spelling or grammar mistakes or information that is inaccurate or confusing.

Acceptance Criteria ☑️

  1. All of the changes described in the "Details" section above are completed.
  2. Ideas and concepts are clearly communicated and not overly technical.
  3. Changes are sensibly formatted without spelling or grammar issues.

Bounty Details 💰

This issue is rewarded by a bounty upon completion. It was estimated by the Gnars Tech Pod as TBD story points which equates to TBD Gnars or TBD $USDC.

@bagelface bagelface added documentation Improvements or additions to documentation bounty Rewarded upon completion labels May 8, 2024
@sktbrd
Copy link
Member

sktbrd commented May 9, 2024

On it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bounty Rewarded upon completion documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants