docs: add more meat to the development section#1801
Merged
CommanderStorm merged 21 commits intomaplibre:mainfrom Apr 25, 2025
Merged
docs: add more meat to the development section#1801CommanderStorm merged 21 commits intomaplibre:mainfrom
CommanderStorm merged 21 commits intomaplibre:mainfrom
Conversation
for more information, see https://pre-commit.ci
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
nyurik
approved these changes
Apr 22, 2025
Member
nyurik
left a comment
There was a problem hiding this comment.
I added a few minor things, but looks great! Feel free to merge once resolved
sharkAndshark
approved these changes
Apr 22, 2025
Collaborator
sharkAndshark
left a comment
There was a problem hiding this comment.
Looks great! Just some small suggestions.
Co-authored-by: Yuri Astrakhan <yuriastrakhan@gmail.com>
Co-authored-by: Lucas <zhangyijunmetro@hotmail.com>
Co-authored-by: Lucas <zhangyijunmetro@hotmail.com>
Co-authored-by: Lucas <zhangyijunmetro@hotmail.com>
Co-authored-by: Lucas <zhangyijunmetro@hotmail.com>
for more information, see https://pre-commit.ci
CommanderStorm
commented
Apr 24, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation by adding clarifying details on development workflows and expanding the feature list for using Martin as a library. Key changes include:
- Updating the feature list in the Martin-as-a-library documentation with new bullet points and nested lists.
- Adding a comprehensive "Development" guide that details git setup, contribution instructions, and tool installation.
- Introducing a new README to facilitate local documentation building and link checking.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/src/martin-as-a-library.md | Expanded feature list with new options and nested bullet formatting |
| docs/src/development.md | Revised and extended instructions for git setup and contributing new code |
| docs/README.md | Added guidance for building and previewing documentation locally |
Comments suppressed due to low confidence (2)
docs/src/martin-as-a-library.md:7
- [nitpick] Consider using a consistent formatting style for feature names across all bullet points (e.g., inline code versus bold). Aligning the style helps maintain a clear and uniform presentation.
* `mbtiles` - enable MBTile tile sources
docs/README.md:23
- Verify that the linked path
src/SUMMARY.mdcorrectly reflects the actual file location in the repository; if it resides elsewhere (for example, in docs/src), update the reference accordingly to avoid broken links.
> Make sure that all pages are linked from [`src/SUMMARY.md`](src/SUMMARY.md).
sharkAndshark
approved these changes
Apr 24, 2025
Co-authored-by: Lucas <zhangyijunmetro@hotmail.com>
Co-authored-by: Yuri Astrakhan <yuriastrakhan@gmail.com>
for more information, see https://pre-commit.ci
CommanderStorm
added a commit
that referenced
this pull request
Apr 25, 2025
Yes, a bit hacky and not the proper solution, but gets this bug silenced. I don't like that CI always fails on docs PRs. F.ex #1801 could be merged, but needs admin approval. A proper solution would be to skip all except `CI FInished` if just docs were changed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR tries to add more meat to the devlopment seciton
Looks like much changed, actually is not.
Here is how the two

detailsblocks look renderedContent wise, some of the explainations are inspired by http://gist.github.com/nyurik/4e299ad832fd2dd43d2b27191ed3ec30/