Reorganize documentation pages #8325
Merged
Conversation
This file contains 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
github-actions
bot
added
documentation
ggerganov
approved these changes
Jul 5, 2024
|
@ngxson But I don't find any link of README-sycl.md in README.md. Through the online document will be easy to read, *.md is still important document to developer and users. So, I suggest to add a chapter in REAMDE.md for backend types and include the links to related documents. |
|
@NeoZhangJianyu The link to SYCL has been moved to
Sounds good to me, I'll that this section in my next PR |
|
@ngxson |
arthw
pushed a commit
to arthw/llama.cpp
that referenced
this pull request
Jul 13, 2024
* re-organize docs * add link among docs * add link to build docs * fix style * de-duplicate sections
arthw
pushed a commit
to arthw/llama.cpp
that referenced
this pull request
Jul 13, 2024
* re-organize docs * add link among docs * add link to build docs * fix style * de-duplicate sections
NikolaiLyssogor
added a commit
to NikolaiLyssogor/llama.cpp
that referenced
this pull request
Jul 14, 2024
Fixes a few links to within the repo that were broken in the reorganization of the documentation in ggerganov#8325.
4 tasks
ggerganov
pushed a commit
that referenced
this pull request
Jul 15, 2024
Fixes a few links to within the repo that were broken in the reorganization of the documentation in #8325.
arthw
pushed a commit
to arthw/llama.cpp
that referenced
this pull request
Jul 27, 2024
Fixes a few links to within the repo that were broken in the reorganization of the documentation in ggerganov#8325.
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 aims to make documentation easier for new users / new contributors:
#, h2##, h3###,...Page structure:
To preview the change, go to: https://github.com/ngxson/llama.cpp/tree/xsn/reorganize_docs
With correct markdown usage, TOC can now be displayed correctly on github. We can add a small script to generate TOC in the future: