Skip to content

📝 Update README #448

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
Merged
merged 1 commit into from
Mar 22, 2021
Merged

📝 Update README #448

merged 1 commit into from
Mar 22, 2021

Conversation

alecgibson
Copy link
Collaborator

ShareDB now has Jekyll-generated documentation, hosted on Github
Pages: https://share.github.io/sharedb/

This change drastically simplifies our README, which is now largely
superseded by the new documentation.

We keep:

  • the introduction to ShareDB and its features
  • a link to the documentation
  • images and links to examples

@alecgibson
📝 Update README
201bda4 
ShareDB now has Jekyll-generated [documentation][1], hosted on Github
Pages: https://share.github.io/sharedb/

This change drastically simplifies our `README`, which is now largely
superseded by the new documentation.

We keep:

 - the introduction to ShareDB and its features
 - a link to the documentation
 - images and links to examples

[1]: #438
@coveralls
Copy link

Coverage Status

Coverage remained the same at 97.386% when pulling 201bda4 on update-readme into 72c680b on master.

pypmannetjies
pypmannetjies approved these changes Mar 22, 2021
View reviewed changes
Copy link
Contributor

@pypmannetjies pypmannetjies left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

@alecgibson alecgibson marked this pull request as draft March 22, 2021 13:51
@alecgibson
Copy link
Collaborator Author

I've just noticed that Jekyll's link tag doesn't seem to work properly with the baseurl config, so marking this as WIP until I figure out the best way to fix that.

NB: It looks like baseurl works as expected in Jekyll v4, but GH Pages is stuck on v3

@alecgibson alecgibson marked this pull request as ready for review March 22, 2021 15:10
@alecgibson alecgibson merged commit 1574270 into master Mar 22, 2021
@alecgibson alecgibson deleted the update-readme branch March 22, 2021 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pypmannetjies pypmannetjies pypmannetjies approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@alecgibson @coveralls @pypmannetjies