Skip to content

docs: add more meat to the development section#1801

Merged
CommanderStorm merged 21 commits intomaplibre:mainfrom
CommanderStorm:better-dev-docs
Apr 25, 2025
Merged

docs: add more meat to the development section#1801
CommanderStorm merged 21 commits intomaplibre:mainfrom
CommanderStorm:better-dev-docs

Conversation

@CommanderStorm
Copy link
Member

This PR tries to add more meat to the devlopment seciton

Looks like much changed, actually is not.

Here is how the two details blocks look rendered
screencapture-file-home-frank-dev-maplibre-martin-target-book-development-html-2025-04-22-02_21_26

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

This comment was marked as resolved.

pre-commit-ci bot and others added 5 commits April 22, 2025 00:24
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.

I added a few minor things, but looks great! Feel free to merge once resolved

Copy link
Collaborator

@sharkAndshark sharkAndshark left a comment

Choose a reason for hiding this comment

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

Looks great! Just some small suggestions.

CommanderStorm and others added 8 commits April 22, 2025 10:06
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>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.md correctly 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).

CommanderStorm and others added 3 commits April 24, 2025 13:02
Co-authored-by: Lucas <zhangyijunmetro@hotmail.com>
Co-authored-by: Yuri Astrakhan <yuriastrakhan@gmail.com>
@CommanderStorm CommanderStorm enabled auto-merge (squash) April 25, 2025 22:06
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.

thanks!

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.
@CommanderStorm CommanderStorm merged commit 98d94d1 into maplibre:main Apr 25, 2025
18 checks passed
@CommanderStorm CommanderStorm deleted the better-dev-docs branch July 10, 2025 17:07
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.

3 participants

Comments