search

protoncr / tourmaline

Simple Telegram bot library for Crystal
https://tourmaline.dev
MIT License
158 stars 38 forks source link

How to contribute to the website? #54

Closed mipmip closed 1 year ago

mipmip commented 2 years ago

It's not clear how to send PR's for the website. There is a tourmaline-website repo and this repo has a gh-pages branch. I see multiple typo's in de code examples or examples that do not work anymore.

It would help if this was clearly documented and if the website-repo is outdated it would be wise to remove it.

Thanks

watzon commented 1 year ago

Sorry it took me a while to get to this, I stepped away from Crystal and Telegram for a while. As far as contributing to the website:

This project uses mkdocstrings-crystal, so you'll need install the dependencies with pip install -r requirements.txt first.

You'll then need to make sure you have shard depencies installed using shards install.

Run mkdocs build to build the files, and mkdocs serve to start a local development server so you can test your changes.

Then all you have to do is commit and push. Once your PR is merged into master a Github action will run that builds the docs and pushes them to the gh_pages branch.