docs: Add small SCOPE.md and GOVERNANCE.md documents by daveallie · Pull Request #640 · crosspoint-reader/crosspoint-reader

daveallie · 2026-02-01T09:53:19Z

Summary

Additional documentation for CrossPoint in the way of a SCOPE.md and GOVERNANCE.md document.
These are intentionally pretty lightweight for now

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 · 2026-02-01T10:07:59Z

@crosspoint-reader/firmware-maintainers keen for any thoughts here

jonasdiemer

Very agreeable to me and a good basis to start. It well describes how I perceive the current way of working.

ngxson · 2026-02-01T11:20:56Z

Hey @daveallie , thanks for the clarification on the scope of the project.

Regarding to the point of not having support for apps, I'm a bit concerned about my PR #638 because it does fall outside of the defined scope.

My main goal of having custom apps is to allow use case where custom articles or info can be pulled to the device. For example, reading news or personal TODO lists.

I would like to ask for your opinion (and maintainers' opinion) if this is something acceptable. If it's not, then I'm happy to keep it on my fork.

jonasdiemer · 2026-02-01T11:29:14Z

I would like to ask for your opinion (and maintainers' opinion) if this is something acceptable. If it's not, then I'm happy to keep it on my fork.

Hi @ngxson. IMO, having custom apps is beyond what CrossPoint is intended to be. I understand your use cases, but I would prefer CrossPoint focusing on the reading aspect and not turn it into a device that can do many things.

I like your PR being considerate to move the functionality into a dedicated area - so we won't have to worry about individual use cases (TODO app, news app, ...). But I am still worried at the overhead (i.e. extra code to maintain, extra bug reports coming in, ...) - so it might be better suited to a fork.

Uri-Tauber · 2026-02-01T13:44:35Z

@daveallie Hey! Quick question about multi-language support — I didn’t see it mentioned explicitly in SCOPE.md.
Would you be open to PRs in this area? I have a few ideas and wanted to check with you before I start coding (after I will finish with #553).
Thanks!

drbourbon · 2026-02-01T13:48:59Z

[...] IMO, having custom apps is beyond what CrossPoint is intended to be. I understand your use cases, but I would prefer CrossPoint focusing on the reading aspect and not turn it into a device that can do many things. [...]

Fully resonating with the crosspoint's 'reading-first' focus.

However, to support a broader community, I suggest we refine the application architecture to be 'fork-friendly' (in order to maximize the success of long-term GitHub automatic merging and PR cherry picking). Here are some possible ideas:

Implement a 'hook' system where external features can be injected (at compile time) without modifying the core codebase (such as for adding stuff on the main menu, or to inject reading features on_page_turned or on_book_opened).
Use a clear API for settings so that forks can add new config parameters without breaking anything.

What do you think?

Eloren1 · 2026-02-01T14:08:25Z

GOVERNANCE.md

+### 2. A "Do-ocracy" with Guidance
+CrossPoint thrives because people step up to build what they want to see.
+- If you want a feature, the best way to get it is to start an 
+  [Idea Discussion](https://github.com/crosspoint-reader/crosspoint-reader/discussions/categories/ideas) or open a PR.


Add info about issues along with info about ideas:

If you want to report a bug, (check for duplicates?) and create it here [https://github.com/crosspoint-reader/crosspoint-reader/issues]

(RESOLVED)

lukestein · 2026-02-01T16:57:08Z

SCOPE.md

+
+### In-Scope: The "Core Reading Experience"
+
+*These are features that directly improve the primary purpose of the device.*


What's here is in my view great, but there's something I think is missing.

Part of the core reading experience is things like switching chapters, seeing progress, syncing progress. I could imagine things like creating bookmarks as being within scope and I know there have been requests for them. Perhaps this also includes things like optimizing the user interface around the reading experience: things like button customization. I think the remains important room for continued development around the reading experience in some of these ways not fully captured (yet) but these sub-bullets.

Yes, users miss bookmarks and sometimes even choose the stock firmware just because of bookmarks and BT-clicker

lukestein · 2026-02-01T17:58:37Z

@daveallie Hey! Quick question about multi-language support — I didn’t see it mentioned explicitly in SCOPE.md.

Agree with @Uri-Tauber that we could provide some more clarity about language support. There's translations in the actual crosspoint UI, but also font/charset support, hyphenation, RTL, … I think supporting reading in many languages is valuable, but also recognize we're constrained on eg memory and can't for example build in hyphenation for every language.

Eloren1 · 2026-02-01T18:50:25Z

@lukestein how about downloadable dictionaries for hyphenations that you can put on sd card?

* master: feat: add shift lock to KeyboardEntryActivity (crosspoint-reader#513) feat: rename and move in file manager (crosspoint-reader#630) feat: Implement fix for sunlight fading issue (crosspoint-reader#603) chore: Add PR title check on sync (crosspoint-reader#698) feat: Go To Position for epubs (crosspoint-reader#666) feat: Calibre Web Automated (CWA) koreader sync server support (crosspoint-reader#594) chore: Add CI check job to consolidate status (crosspoint-reader#696) chore: CI Build Summary - firmware stats, firmware artifact (crosspoint-reader#601) feat: quick rotate option in epub reader menu (crosspoint-reader#685) feat(settings): add "Cover + Custom" sleep screen mode (crosspoint-reader#582) fix: Artifacts on Thumb on Home Screen (crosspoint-reader#662) feat: holding back button while booting, boots to home screen as a mean of escaping boot loop (crosspoint-reader#587) docs: Add small SCOPE.md and GOVERNANCE.md documents (crosspoint-reader#640) feat: front button remapper (crosspoint-reader#664) feat: UI themes, Lyra (crosspoint-reader#528) feat: Add CSS parsing and CSS support in EPUBs (crosspoint-reader#411) fix: move http upload state to heap (crosspoint-reader#657)

daveallie added 2 commits February 1, 2026 20:52

docs: Add small SCOPE.md and GOVERNANCE.md documents

2940439

Update README.md

e08cf3f

jonasdiemer previously approved these changes Feb 1, 2026

View reviewed changes

daveallie dismissed jonasdiemer’s stale review via e08cf3f February 1, 2026 10:48

jonasdiemer previously approved these changes Feb 1, 2026

View reviewed changes

osteotek previously approved these changes Feb 1, 2026

View reviewed changes

Eloren1 reviewed Feb 1, 2026

View reviewed changes

lukestein reviewed Feb 1, 2026

View reviewed changes

ngxson mentioned this pull request Feb 1, 2026

feat: implement user-defined apps #638

Closed

5 tasks

Uri-Tauber mentioned this pull request Feb 3, 2026

feat(extensions): add partition-based app support #679

Draft

This was referenced Feb 3, 2026

Feature request: changing sleep image #669

Open

Feature request: Instapaper integration #277

Closed

feat: Add inverse display setting #659

Open

Add more clarity of in and out of scope items

dd1649f

daveallie dismissed stale reviews from osteotek and jonasdiemer via dd1649f February 5, 2026 11:37

daveallie merged commit 5a9ee19 into master Feb 5, 2026
1 check passed

daveallie deleted the docs/scope branch February 5, 2026 11:38

daveallie mentioned this pull request Feb 5, 2026

chore(release): 1.0.0 Release Candidate #700

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: Add small SCOPE.md and GOVERNANCE.md documents#640

docs: Add small SCOPE.md and GOVERNANCE.md documents#640
daveallie merged 3 commits intomasterfrom
docs/scope

daveallie commented Feb 1, 2026

Uh oh!

daveallie commented Feb 1, 2026

Uh oh!

jonasdiemer left a comment

Uh oh!

ngxson commented Feb 1, 2026 •

edited

Loading

Uh oh!

jonasdiemer commented Feb 1, 2026

Uh oh!

Uri-Tauber commented Feb 1, 2026

Uh oh!

drbourbon commented Feb 1, 2026 •

edited

Loading

Uh oh!

Eloren1 Feb 1, 2026 •

edited

Loading

Uh oh!

lukestein Feb 1, 2026

Uh oh!

Eloren1 Feb 1, 2026

Uh oh!

lukestein commented Feb 1, 2026

Uh oh!

Eloren1 commented Feb 1, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants


		### In-Scope: The "Core Reading Experience"

		These are features that directly improve the primary purpose of the device.

Uh oh!

Conversation

daveallie commented Feb 1, 2026

Summary

AI Usage

Uh oh!

daveallie commented Feb 1, 2026

Uh oh!

jonasdiemer left a comment

Choose a reason for hiding this comment

Uh oh!

ngxson commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jonasdiemer commented Feb 1, 2026

Uh oh!

Uri-Tauber commented Feb 1, 2026

Uh oh!

drbourbon commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Eloren1 Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lukestein Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

Eloren1 Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

lukestein commented Feb 1, 2026

Uh oh!

Eloren1 commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

ngxson commented Feb 1, 2026 •

edited

Loading

drbourbon commented Feb 1, 2026 •

edited

Loading

Eloren1 Feb 1, 2026 •

edited

Loading

Eloren1 commented Feb 1, 2026 •

edited

Loading