Docs Updates#949
Merged
Merged
Conversation
Contributor
angpt
commented
Apr 23, 2026
angpt
commented
- Adds contributing guide + pr template
- Updates docs links to Gitbook links
Replace relative docs/ paths and add verified GitBook URLs for all documentation links in README.md and README_0.10.0.md. Update CONTRIBUTING.md to mention docs/SUMMARY.md when adding pages. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
aittalam
reviewed
Apr 28, 2026
|
|
||
| We welcome fixes, docs improvements, tests, build work, and larger feature work. | ||
|
|
||
| If your change touches the `llama.cpp/` submodule, also read [`llama.cpp/CONTRIBUTING.md`](llama.cpp/CONTRIBUTING.md). That file covers additional upstream expectations for code style, testing, and review. |
Member
There was a problem hiding this comment.
I am not sure whether this applies here. We do touch the submodules, but just with patches that allow us to work with them in our own project. Perhaps we should make it more clear that if we consider the change something that should end upstream, then it should become a PR to llama.cpp, otherwise it is sufficient to follow the instructions to modify submodules?
| - `unzip` | ||
| - Git | ||
|
|
||
| Windows contributors also need Cosmos bash. |
Member
There was a problem hiding this comment.
We should check if this is enough for building llamafile from scratch there.
I have tried MSYS2 for building dlls, and @javiermtorres replicated the build on WSL, but I think neither has tried cosmos bash.
- Clarify submodule changes are patch-based; direct upstream changes should be PRs to the upstream repo - Replace unverified "Cosmos bash" Windows prereq with MSYS2/WSL and link to building_dlls.md - Add link to detailed submodule patch workflow docs
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.