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.

Sign up for GitHub

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

Jump to bottom

Clarinet: Restructure doc hierarchy #638

Closed
hugocaillard opened this issue Oct 5, 2023 · 0 comments
Closed

Clarinet: Restructure doc hierarchy #638

hugocaillard opened this issue Oct 5, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@hugocaillard
Copy link
Collaborator

hugocaillard commented Oct 5, 2023 •
edited
Loading

Description

We currently have almost 20 documentation pages, I think we could have less and make it easier to read.

New structure

  1. Getting started (intro + install)
  2. Create a project and a contract
  3. Using published contracts (requirements)
  4. Validate contracts (vscode extension + clarinet check + check checker)
  5. Testing and debugging (clarinet-sdk with vitest)
  6. Devnet (clarinet integrate)
  7. Deploying contracts
  • Annexes
    1. FAQ & Trouble shooting
    2. Clarinet SDK API references
    3. Deployment plans
    4. Subnet
@andresgalante andresgalante added the documentation Improvements or additions to documentation label Nov 6, 2023
@hugocaillard hugocaillard changed the title Restructure doc hierarchy Clarinet: Restructure doc hierarchy Mar 25, 2024
@hugocaillard hugocaillard transferred this issue from hirosystems/clarinet Mar 25, 2024
@github-project-automation github-project-automation bot moved this to 🆕 New in Hiro Docs Mar 25, 2024
@github-project-automation github-project-automation bot moved this to 🆕 New in Devrel Mar 25, 2024
@github-project-automation github-project-automation bot moved this from 🆕 New to ✅ Done in Hiro Docs May 9, 2024
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in DevTools May 9, 2024
@github-project-automation github-project-automation bot moved this from 🆕 New to ✅ Done in Devrel May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
DevTools
Archived in project
Devrel
Archived in project
Hiro Docs
Archived in project
Milestone
No milestone
Development

No branches or pull requests
3 participants
@hugocaillard @andresgalante @ryanwaits