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

Improve documentation website. #1

Open
egoist opened this issue May 18, 2020 · 1 comment
Open

Improve documentation website. #1

egoist opened this issue May 18, 2020 · 1 comment
Labels
bug Something isn't working

Comments

@egoist
Copy link

egoist commented May 18, 2020

Hi just FYI, the website (https://vic.github.io/laminar_cycle/) is broken, you need to remove root option from index.html .

base: '/laminar_cycle/ is also needed for correctly setting the link of site title.

@vic
Copy link
Owner

vic commented May 25, 2020

Thanks for the heads up.

I still have a lot of work to do regarding documentation. Split the README into a proper guide -on core concepts- and documentation/examples for each driver.

Most likely the docs/ directory will move from using docup to scalameta's mdoc since the later provides compile time checks for scala examples.

I'll rename this issue and keep it open to remind me of tackling this.

@vic vic changed the title The website is broken Improve documentation website. May 25, 2020
@vic vic added the bug Something isn't working label May 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants