Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ security:
@echo "$(GREEN)Security audit completed!$(NC)"

# Install the dependencies needed to build the documentation (Sphinx + MyST +
# Furo + extensions, listed in docs/requirements.txt). Also installs the
# the Read the Docs theme + extensions, listed in docs/requirements.txt). Also installs the
# package itself in editable mode so autodoc can import it.
.PHONY: install-docs
install-docs:
Expand Down
16 changes: 15 additions & 1 deletion docs/api/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# API Reference

Every public class, method and helper PyMemoryEditor exposes. For
task-oriented walkthroughs, see the [User Guide](../guide/index.md).
task-oriented walkthroughs, start at
[Opening a process](../guide/opening-process.md).

## At a glance

Expand All @@ -20,14 +21,27 @@ task-oriented walkthroughs, see the [User Guide](../guide/index.md).

```{toctree}
:maxdepth: 1
:caption: The Entry Point

openprocess
enums
```

```{toctree}
:maxdepth: 1
:caption: Objects You Get Back

memory-region
remote-pointer
pointer-path
module-info
thread-info
```

```{toctree}
:maxdepth: 1
:caption: Errors and Helpers

errors
utilities
```
53 changes: 0 additions & 53 deletions docs/guide/index.md

This file was deleted.

74 changes: 57 additions & 17 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ scans, freezing values) to a small, friendly API that works **identically on
Windows, Linux and macOS**.

Get going with the [Installation](installation.md) and [Quick Start](quickstart.md)
pages, then dig into the [User Guide](guide/index.md) for the in-depth walkthroughs.
pages, then work through the guide itself, starting at
[Opening a process](guide/opening-process.md).
Prefer to click rather than type? The bundled [GUI app](app.md) gives you a
Cheat Engine-style interface for free.

Expand Down Expand Up @@ -100,48 +101,87 @@ explore, scan and freeze values by clicking.
</tr>
</table>

## User's Guide
## Documentation

This part of the documentation walks you through every workflow, from opening a
process to following multi-level pointer chains, plus the bundled GUI app.
Every workflow is covered, from opening a process to following multi-level
pointer chains — plus the bundled GUI app, the MCP server for AI assistants,
and the reference for every public symbol. Each group below stands on its own,
so you can start wherever your question is.

```{toctree}
:maxdepth: 2
:maxdepth: 1
:caption: Getting Started

why
installation
quickstart
guide/index
app
mcp
```

## API Reference
```{toctree}
:maxdepth: 1
:caption: Core Workflow

If you are looking for information on a specific class, method or parameter,
this part of the documentation is for you.
guide/opening-process
guide/read-write
guide/searching
guide/pattern-scan
```

```{toctree}
:maxdepth: 2
:maxdepth: 1
:caption: Inspecting the Process

api/index
guide/memory-regions
guide/modules-threads
```

```{toctree}
:maxdepth: 1
:caption: Pointers

guide/pointers
guide/pointer-scan
```

```{toctree}
:maxdepth: 1
:caption: Memory Allocation

guide/allocate-free
```

## Additional Notes
```{toctree}
:maxdepth: 1
:caption: Tools

Platform-specific behaviour, troubleshooting, logging, a glossary of the terms
used throughout these docs, plus how to contribute and the project's license.
app
mcp
```

```{toctree}
:maxdepth: 2
:caption: API Reference

api/index
```

```{toctree}
:maxdepth: 1
:caption: Additional Notes

platform-notes
troubleshooting
guide/logging
glossary
```

```{toctree}
:maxdepth: 1
:caption: Project

contributing
funding
license
glossary
```

## Project links
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ any platform.
pip install PyMemoryEditor
```

## Install with the bundled GUI app
## Install with the bundled GUI (`app`)

The library ships an optional Cheat Engine-style GUI built on **PySide6
(Qt for Python)**. To install it, use the `app` extra:
Expand Down
Loading