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

Move documentation to docs #185

Merged
merged 4 commits into from
Nov 1, 2024
Merged

Move documentation to docs #185

merged 4 commits into from
Nov 1, 2024

Conversation

guidanoli
Copy link
Contributor

@guidanoli guidanoli commented Oct 31, 2024

This makes the root README slimmer.

Copy link

vercel bot commented Oct 31, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
bug-buster ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 31, 2024 8:26pm

@claudioantonio claudioantonio added the a-documentation Area: documentation label Oct 31, 2024
Copy link
Contributor

@claudioantonio claudioantonio left a comment

Choose a reason for hiding this comment

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

suggestion: I think we could work a bit on the structure to guide better the newcomers. For example:

  • Running
    • Backend
    • Populating state
    • Frontend
  • Contributing
    • General guideline
    • Using the CLI
    • Tests
    • Debugging
  • Future work

The README was really needing some care! 🙏

Copy link
Contributor

@claudioantonio claudioantonio left a comment

Choose a reason for hiding this comment

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

Much better IMO! Kudos!

@guidanoli guidanoli merged commit 3b24a8b into next Nov 1, 2024
4 checks passed
@guidanoli guidanoli deleted the feature/nested-docs branch November 1, 2024 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a-documentation Area: documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants