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

Create mdbook documentation #681

Merged
merged 4 commits into from
May 29, 2023
Merged

Create mdbook documentation #681

merged 4 commits into from
May 29, 2023

Conversation

sharkAndshark
Copy link
Collaborator

No description provided.

Copy link
Member

@nyurik nyurik left a 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator Author

@sharkAndshark sharkAndshark May 27, 2023

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

Copy link
Member

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

@sharkAndshark
Copy link
Collaborator Author

Do you think we need adjust the structure of book? @nyurik

@nyurik
Copy link
Member

nyurik commented May 27, 2023

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.

@sharkAndshark
Copy link
Collaborator Author

Yeah.One PR for one thing

Copy link
Member

@nyurik nyurik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you !! merging

@nyurik nyurik marked this pull request as ready for review May 29, 2023 01:36
@nyurik nyurik enabled auto-merge (squash) May 29, 2023 01:36
@nyurik nyurik disabled auto-merge May 29, 2023 01:59
@nyurik nyurik enabled auto-merge (squash) May 29, 2023 01:59
@nyurik nyurik merged commit 56dde81 into maplibre:main May 29, 2023
@sharkAndshark sharkAndshark deleted the mdbook branch June 2, 2023 01:27
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