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

fix(docs): add Move section to README and improve README readability #8

Merged
merged 11 commits into from
Jan 18, 2024
Merged

fix(docs): add Move section to README and improve README readability #8

merged 11 commits into from
Jan 18, 2024

Conversation

ndom91
Copy link
Contributor

@ndom91 ndom91 commented Jan 15, 2024

Rendered

  • Add <summary /> / <detail /> sections around all sub-sections to improve readability
  • Add Move docs section

It won't let me tag you as reviewer for whatever reason 🤔 @huntabyte

Preview screenshot:

image

Copy link

changeset-bot bot commented Jan 15, 2024

⚠️ No Changeset found

Latest commit: 3c2e8a6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ndom91 ndom91 marked this pull request as ready for review January 15, 2024 13:22
@ndom91 ndom91 changed the title chore: cleanup README fix(docs): add Move section to README and improve README readability Jan 15, 2024
Copy link
Member

@huntabyte huntabyte left a comment

Choose a reason for hiding this comment

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

Thanks a ton for this!! Will make things much better until I can get some docs stood up for it which I plan to do later this week!

README.md Outdated Show resolved Hide resolved
@ndom91
Copy link
Contributor Author

ndom91 commented Jan 16, 2024

Speaking of docs, what do you like to use for docs sites? Is there a svelte alternative to vitepress, docusaurus, etc? Or you just spin up something custom?

I've been looking for something for a new svelte project of mine haha

Co-authored-by: Hunter Johnston <[email protected]>
@ndom91 ndom91 requested a review from huntabyte January 16, 2024 09:00
@huntabyte
Copy link
Member

Speaking of docs, what do you like to use for docs sites? Is there a svelte alternative to vitepress, docusaurus, etc? Or you just spin up something custom?

I've been looking for something for a new svelte project of mine haha

There are a few but I've found they don't quite compare to the ones that exist for other frameworks so I have my own which I spin up and modify based on the project. Will likely publish it soon as I get the time to document it but its pretty straightforward. https://github.com/huntabyte/formsnap is using it.

@huntabyte
Copy link
Member

Sorry for the delay in getting this merged, on travel this week! Appreciate you taking the time to do this!

@huntabyte huntabyte merged commit 05d793f into svecosystem:main Jan 18, 2024
3 checks passed
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.

2 participants