Skip to content

Update documentation#582

Merged
guumaster merged 2 commits intodevelopfrom
feat/update-documentation
Jan 11, 2022
Merged

Update documentation#582
guumaster merged 2 commits intodevelopfrom
feat/update-documentation

Conversation

@yahia-kerim
Copy link
Copy Markdown
Collaborator

@yahia-kerim yahia-kerim commented Dec 6, 2021

Checklist: #576.

  • Update the documentation to explain the async/await syntax & the new options.
  • Add a typescript example on how to setup the plugin.
  • Add Mkdocs configuration file to generate a simple, beautiful static website for the documentation.
  • Split the documentation into files (each file is corresponding to a page in the static site).
  • Add the versioning to the generated static site to save the current v4.6 doc.
  • Automate the static site generation using Github actions.

Using Mkdocs & Material for MkDocs theme, the generated static site will be pushed to a branch called gh-pages & deployed using Github pages.

Please check my forked repository yahiakr/mongoosastic:gh-pages for more details.

The generated static site is deployed here: https://yahiakr.github.io/mongoosastic/

@yahia-kerim yahia-kerim mentioned this pull request Dec 7, 2021
13 tasks
@guumaster
Copy link
Copy Markdown
Member

This is looking amazing already. Excellent work!

@guumaster guumaster merged commit 2266b38 into develop Jan 11, 2022
@guumaster guumaster deleted the feat/update-documentation branch January 11, 2022 13:18
guumaster pushed a commit that referenced this pull request Mar 16, 2022
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