maxtek6 / maxtek6/mio

Reorganize API

Open
#30 2 comments 0 reactions 1 assignee View on GitHub

@johnpatek is already working on this.

Since Apr 14, 2026.

Dominant language
C++
Stars
10
Forks
2
Avg merge
1h 47m
Merged PRs (30d)
2

Description

The file structure and API layout should be updated to be more intuitive. Without breaking the API, things like utilities and platform specific code should have a clear and logical location within the codebase. Within files, a good general rule would be the following:

  • preprocessor and constants at the top
  • core classed and functions in the middle
  • convenience and utility code at the bottom

It is unclear how much of this can be done with the existing header structure, as there are things like page.hpp, which has page offset/alignment related functions, but also includes access mode definitions and some platform specific code.

Contributor guide

No contributing guide indexed for this repository

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.