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

chore: improve get started #509

Merged
merged 4 commits into from
Jun 25, 2024
Merged

Conversation

floridemai
Copy link
Contributor

Getting started page was pretty empty and we choose to load the readme file and use that.

Options:

  • "start" with the readme and create another example section as per the ticked
  • simply add a how to use in the readme and just place the readme in the get started page
    (The tricky part is that it's a get started while the readme starts with a header and the name)

Solution:
I see what you mean, but considering the simplicity of the solution that embeds the readme, I'm happy with including the raw readme in there. Let's expand the readme with a simple usage section and we're done

Copy link

netlify bot commented Jun 25, 2024

Deploy Preview for quantum-deploy-previews ready!

Name Link
🔨 Latest commit 947732b
🔍 Latest deploy log https://app.netlify.com/sites/quantum-deploy-previews/deploys/667a8c05daf1ee0009cfb752
😎 Deploy Preview https://deploy-preview-509--quantum-deploy-previews.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@floridemai floridemai linked an issue Jun 25, 2024 that may be closed by this pull request
Copy link
Member

@simoneb simoneb left a comment

Choose a reason for hiding this comment

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

If it renders fine, we're good.

@floridemai floridemai merged commit e25aaf8 into nearform:main Jun 25, 2024
7 checks passed
@floridemai floridemai deleted the 502-improve-docs branch June 25, 2024 09:24
@github-actions github-actions bot mentioned this pull request Jun 26, 2024
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.

Improve docs
2 participants