diff --git a/docs/getstarted/1-account.md b/docs/getstarted/01-account.md similarity index 100% rename from docs/getstarted/1-account.md rename to docs/getstarted/01-account.md diff --git a/docs/index.md b/docs/index.md index 3cbf821..6b4b655 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,5 @@ # FindMy.py -= 🍏 + 🎯 + 🐍! - FindMy.py is a Python library aiming to provide everything you need to interact with **Apple's FindMy Network**. Its primary aims are feature completeness, reliability and elegant API design. @@ -9,22 +7,26 @@ It abstracts all the heavy lifting away, while keeping the control flow in your ## Jump To -[//]: # (This is hidden to prevent it from showing on the home page) +[//]: # "This is hidden to prevent it from showing on the home page" + ```{toctree} :hidden: Home ``` -[//]: # (Documentation can be expanded to maxdepth 2) +[//]: # "Documentation can be expanded to maxdepth 2" + ```{toctree} :maxdepth: 2 getstarted/index technical/index +reveng/index ``` -[//]: # (Show these with a maxdepth of 1) +[//]: # "Show these with a maxdepth of 1" + ```{toctree} :maxdepth: 1 diff --git a/docs/reveng/20-Network_Requests.md b/docs/reveng/20-Network_Requests.md new file mode 100644 index 0000000..312d274 --- /dev/null +++ b/docs/reveng/20-Network_Requests.md @@ -0,0 +1,13 @@ +# Intercepting Network Requests + +A big part of our understanding of how the FindMy network functions originates from +network captures detailing how official apps query location reports. +This page aims to provide a quickstart on setting up an environment in which you can +freely inspect network requests made the FindMy app on a Mac. + +```{note} +This guide has only been tested on Sonoma, but it will likely work on other +versions of MacOS as well. +``` + +TODO diff --git a/docs/reveng/index.md b/docs/reveng/index.md new file mode 100644 index 0000000..57a03eb --- /dev/null +++ b/docs/reveng/index.md @@ -0,0 +1,14 @@ +# Reverse Engineering + +Want to help reverse engineer pieces of the FindMy network? That's great! +The pages in this category aim to provide documentation on how various parts +of the FindMy network have been reverse engineered, and how you can replicate this setup. + +--- + +```{toctree} +:maxdepth: 1 +:glob: + +* +``` diff --git a/docs/technical/1-Network.md b/docs/technical/10-Network.md similarity index 100% rename from docs/technical/1-Network.md rename to docs/technical/10-Network.md diff --git a/docs/technical/10-AirTags.md b/docs/technical/11-AirTags.md similarity index 100% rename from docs/technical/10-AirTags.md rename to docs/technical/11-AirTags.md