Skip to content

docs: Add detailed webserver documentation#446

Merged
daveallie merged 1 commit intocrosspoint-reader:masterfrom
yeyeto2788:feature/detailed-webserver-docs
Jan 21, 2026
Merged

docs: Add detailed webserver documentation#446
daveallie merged 1 commit intocrosspoint-reader:masterfrom
yeyeto2788:feature/detailed-webserver-docs

Conversation

@yeyeto2788
Copy link
Contributor

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


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

@daveallie daveallie merged commit e3d6e32 into crosspoint-reader:master Jan 21, 2026
2 checks passed
@yeyeto2788 yeyeto2788 deleted the feature/detailed-webserver-docs branch January 21, 2026 13:50
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**_
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.

2 participants