docs: Add git submodule install instructions#602
Merged
Merged
Conversation
Building without initialized submodules fails with a cryptic TS6053 error because morecantile's tsconfig references files in the spec submodule. Document the required init step. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
abarciauskas-bgse
changed the title
abarciauskas-bgse
changed the title
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
2 participants
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.
While attempting to run the examples locally, I found a step was missing (I think?) from the setup instructions which is to install git submodules. This PR adds instructions for doing install git submodules.
I also thought it might be easier in the future to maintain all setup instructions in one place and link to that on the individual examples pages, but I can revert that change if you like have standalone READMEs for each example. (Or if you like that change I can apply it across examples)