Skip to content

Commit 2e72671

Browse files
Add AI-ready PythonIDE docs page
1 parent 9f711f9 commit 2e72671

12 files changed

Lines changed: 14136 additions & 67 deletions

docs/CNAME

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
pythonide.xin
1+
pythonide.xin

docs/docs/index.html

Lines changed: 456 additions & 0 deletions
Large diffs are not rendered by default.

docs/index.html

Lines changed: 38 additions & 66 deletions
Large diffs are not rendered by default.

docs/llms-full.txt

Lines changed: 809 additions & 0 deletions
Large diffs are not rendered by default.

docs/llms.txt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# PythonIDE Docs
2+
3+
> Public docs and machine-readable contracts for generating PythonIDE Mini Apps, widgets, scene scripts, ui scripts, and iOS native capability calls.
4+
5+
## Start Here
6+
7+
- [One-page docs](https://pythonide.xin/docs/): human-readable and AI-readable PythonIDE guide.
8+
- [Full AI context](https://pythonide.xin/llms-full.txt): combined generation rules, quick starts, and complete public API surfaces.
9+
10+
## Machine-Readable API Contracts
11+
12+
- [AppUI schema](https://pythonide.xin/schemas/appui_api_schema.json): canonical AppUI public API projection.
13+
- [Widget schema](https://pythonide.xin/schemas/widget_api_schema.json): canonical Widget public API projection.
14+
- [Native capabilities schema](https://pythonide.xin/schemas/native_capabilities_schema.json): canonical iOS native capability projection.
15+
- [appui.pyi](https://pythonide.xin/stubs/appui.pyi): AppUI typing surface.
16+
- [widget.pyi](https://pythonide.xin/stubs/widget.pyi): Widget typing surface.
17+
- [ui.pyi](https://pythonide.xin/stubs/ui.pyi): Pythonista-compatible ui typing surface.
18+
- [scene.pyi](https://pythonide.xin/stubs/scene.pyi): Pythonista-compatible scene typing surface.
19+
20+
## Generation Rules
21+
22+
- Use `appui` for Mini Apps and interactive native UI.
23+
- Use `widget` for iOS Home Screen widgets.
24+
- Use `scene` for 2D scene/game scripts.
25+
- Use `ui` only for Pythonista-compatible UI scripts.
26+
- Use iOS native modules only when listed in the native capabilities schema.
27+
- Do not invent APIs. Do not use tkinter, PyQt, Flask, Streamlit, or browser/server frameworks for Mini Apps or widgets.
28+
- Output runnable Python code for PythonIDE unless the user asks for explanation only.

0 commit comments

Comments
 (0)