-
-
Notifications
You must be signed in to change notification settings - Fork 227
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
Create mdbook documentation #681
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like a great start, thanks! I added a justfile target for it to simplify things and pushed it to your branch. Looking forward to having a proper docs soon!
.gitignore
Outdated
@@ -10,3 +10,4 @@ test_log* | |||
pg_data/ | |||
config.yml | |||
tests/output/ | |||
docs/book |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please enable "auto newline at the end of a file" in your IDE, e.g. https://stackoverflow.com/questions/16761227/how-to-make-intellij-idea-insert-a-new-line-at-every-end-of-file
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah. I didn't know this and enable it on vscode now. I'm trying to understand why it's important by google. Thx :D
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why its important to have last new line? Same reason as that we want trailing commas in a list, even though last comma is optional: if you make a change to the code, e.g. add one more line, you want the diff
to only show one line change, not two
Do you think we need adjust the structure of book? @nyurik |
Sure, any restructuring is possible - but I think we should start with matching the current readme, migrate to mdbook (e.g. make it auto-publish to the maplibre.org/martin site), and then start changing - otherwise we will have two duplicate places to keep up to date, and that's never good. |
Yeah.One PR for one thing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thank you !! merging
No description provided.