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

Migrate to VitePress, include rs.js docs #91

Merged
merged 57 commits into from
Aug 8, 2024
Merged

Conversation

raucao
Copy link
Member

@raucao raucao commented Jul 1, 2024

@raucao raucao requested review from rosano and DougReeder July 26, 2024 11:33
@raucao
Copy link
Member Author

raucao commented Jul 26, 2024

I think we're done for this PR, not withstanding further improvements afterwards.

See the updated README for instructions for local previews.

I added a GitHub action, which should deploy the new website to GitHub pages once this PR is merged, and then whenever the master branch is updated.

@DougReeder
Copy link
Contributor

In order to run git submodule update --init, you must have have a public SSH key associated with your GitHub account. That's a reasonable requirement, but it needs to be documented.

@raucao
Copy link
Member Author

raucao commented Jul 26, 2024

@DougReeder Resolved in the latest commit. Thanks.

Copy link
Contributor

@DougReeder DougReeder left a comment

Choose a reason for hiding this comment

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

It looks good. As soon as the instructions at rs.js/docs/contributing/docs.html are replaced, we're good to go.

@raucao
Copy link
Member Author

raucao commented Aug 5, 2024

@DougReeder OK, thanks. Opened remotestorage/remotestorage.js#1317 for it.

I edited it directly on GitHub, just to test that it's possible/easy to contribute docs changes without even setting up the local preview.

@raucao raucao merged commit b32b877 into master Aug 8, 2024
@raucao raucao deleted the feature/vitepress branch August 8, 2024 08:27
@raucao
Copy link
Member Author

raucao commented Aug 8, 2024

I fixed a few minor issues directly on master after merging this PR. We're live!

bluesbrothers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants