Plans for next updates: Cleaning up code & creating documentation

Open
#211 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@cmsd2 is already working on this.

Since Aug 10, 2026.

  • #311 by @cmsd2 — open

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
android, kotlin

Research direction

Start by reading DrawCanvas, PageView, and PageDataManager, then trace how the history stack and application signals are handled. The issue lists documentation and code cleanup across several areas, but does not identify specific files or tests. Done would mean the drawing, layering, and signal flow are documented and the listed cleanup and page navigation bugs are addressed.

Written by the indexing model from the issue text.

Description

documentation enhancement

Project become quite large, and its getting harder to navigate. After few months of break I had trouble navigating it.

  1. Split the DrawCanvas logic to separate the logic that uses OnyxSdk and one that's draw in regular android way.
  • Start a good foundation for drawing without onyx sdk.
  1. Create a good Snack and error reporting class. It has to:
  • Allow for snacks with buttons
  • Have a good documentation how to use it
  1. Clean up code for page previous
  • fix bugs related to page previous
  1. documentation:
  • How drawing works, what DrawCanvas does
  • What PageView does
  • How PageDataManager works
  • how history stack is handled
  • how application is layered, how signals travel in the app
Dominant language
Kotlin
Stars
269
Forks
44
Avg merge
1d 17h
Merged PRs (30d)
22

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Ethran/notable

All issues in Ethran/notable

Similar issues

More Kotlin issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.