docs: Add detailed webserver documentation#446
Merged
daveallie merged 1 commit intocrosspoint-reader:masterfrom Jan 21, 2026
Merged
docs: Add detailed webserver documentation#446daveallie merged 1 commit intocrosspoint-reader:masterfrom
daveallie merged 1 commit intocrosspoint-reader:masterfrom
Conversation
daveallie
approved these changes
Jan 21, 2026
jdk2pq
added a commit
to jdk2pq/crosspoint-reader
that referenced
this pull request
Jan 23, 2026
* master: chore: Cut release 0.15.0 fix: OPDS browser OOM (crosspoint-reader#403) docs: Add detailed webserver documentation (crosspoint-reader#446) feat: invalidate cache on web uploads and opds downloads and add Clear Cache action (crosspoint-reader#393) fix: hard reset via RTS pin after flashing firmware (crosspoint-reader#437) fix: Skip negative screen coordinates only after we read the bitmap row. (crosspoint-reader#431) Reclaim space if we don't show battery Percentage (crosspoint-reader#352) feat: Include superscripts and subscripts in fonts (crosspoint-reader#463) My Library: Tab bar w/ Recent Books + File Browser (crosspoint-reader#250) feat: adding categories to settings screen (crosspoint-reader#331)
yingirene
pushed a commit
to yingirene/crosspoint-reader
that referenced
this pull request
Jan 25, 2026
## More detailed documentation * **What is the goal of this PR?** Add more information about the exposed webserver. * **What changes are included?** Detailed documentation for the webserver endpoints (`./docs/webserver-endpoints.md`) Adding a table of content so it is easier to navigate directly to the section you're interested on (Almost all `.md` files or at least all those relevant) ## Additional Context Not sure if this would get accepted but I thought it might be useful for those trying to create separate apps that would sync files to the device. It was at least to me trying to upload files using python as stated [here](crosspoint-reader#434 (comment)) --- ### AI Usage While CrossPoint doesn't have restrictions on AI tools in contributing, please be transparent about their usage as it helps set the right context for reviewers. Did you use AI tools to help write this code? _**PARTIALLY**_
Unintendedsideeffects
pushed a commit
to Unintendedsideeffects/crosspoint-reader
that referenced
this pull request
Feb 17, 2026
## More detailed documentation * **What is the goal of this PR?** Add more information about the exposed webserver. * **What changes are included?** Detailed documentation for the webserver endpoints (`./docs/webserver-endpoints.md`) Adding a table of content so it is easier to navigate directly to the section you're interested on (Almost all `.md` files or at least all those relevant) ## Additional Context Not sure if this would get accepted but I thought it might be useful for those trying to create separate apps that would sync files to the device. It was at least to me trying to upload files using python as stated [here](crosspoint-reader#434 (comment)) --- ### AI Usage While CrossPoint doesn't have restrictions on AI tools in contributing, please be transparent about their usage as it helps set the right context for reviewers. Did you use AI tools to help write this code? _**PARTIALLY**_
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.
More detailed documentation
Add more information about the exposed webserver.
Detailed documentation for the webserver endpoints (
./docs/webserver-endpoints.md)Adding a table of content so it is easier to navigate directly to the section you're interested on (Almost all
.mdfiles or at least all those relevant)Additional Context
Not sure if this would get accepted but I thought it might be useful for those trying to create separate apps that would sync files to the device. It was at least to me trying to upload files using python as stated here
AI Usage
While CrossPoint doesn't have restrictions on AI tools in contributing, please be transparent about their usage as it
helps set the right context for reviewers.
Did you use AI tools to help write this code? PARTIALLY