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

VuePress docs #556

Merged
merged 12 commits into from Dec 31, 2019
Merged

VuePress docs #556

merged 12 commits into from Dec 31, 2019

Conversation

marshallswain
Copy link
Member

@marshallswain marshallswain commented Nov 27, 2019

This moves the docs from the old feathers-plus/docs repository directly into this project.

  • Use VuePress
  • Dark theme (automatically follows the dark mode setting for browsers and operating systems which support it)
  • Move hooks to their own page.
  • Move utilities to their own page.
  • Replace hooksApi utils with actual markdown tables.
  • Replace hooksApiFootnote utils with actual content
  • Remove recent deprecations
  • Update docs for getByDot, setByDot, deleteByDot, and any others that have recently changed.

Screen Shot 2019-11-27 at 1 43 41 PM

Screen Shot 2019-11-27 at 1 43 34 PM

Screen Shot 2019-11-27 at 1 44 47 PM

Screen Shot 2019-11-27 at 1 45 23 PM

Screen Shot 2019-11-27 at 1 47 04 PM

@daffl daffl changed the title WIP: VuePress docs VuePress docs Dec 30, 2019
@daffl
Copy link
Member

daffl commented Dec 30, 2019

The above action items have now been done. Other things left to do:

  • Update softDelete docs with new softDelete
  • Use Feathers docs Vuepress template (it doesn't have a dark mode version yet but it would be great to have one)
  • Set up subdomain and Netlify deploy

@daffl
Copy link
Member

daffl commented Dec 31, 2019

Going to merge this since it's pretty much ready to go for now and I'd like to deploy a build. Other docs should go with their respective or separate PRs.

@daffl daffl merged commit 3a8d73e into master Dec 31, 2019
@daffl daffl deleted the docs branch December 31, 2019 05:31
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.

None yet

2 participants