Skip to content

Latest commit

 

History

History
125 lines (105 loc) · 7.56 KB

development.md

File metadata and controls

125 lines (105 loc) · 7.56 KB

Developing Logistics

Start with setup and your first change. It covers running the app, choosing a code owner, running focused checks and updating the right guide. The worked LM attachment contribution traces a complete change through registration, implementation and tests. The commands below run from the repository root; use py instead of python3 on Windows.

python3 dev.py doctor
python3 dev.py owners
python3 dev.py --help
python3 dev.py test desktop test_feature_registry.py
python3 dev.py lint

Find the place to edit

Change Start here Guide
A feature's controls or behavior Python/features/<feature>/; desktop presentation in ui/, mobile adapters in mobile/ Code and owner map
Desktop navigation, document tabs or browser hosting Python/desktop/ Architecture, browser ownership
Mobile navigation, storage or document lifetime Python/mobile/ Mobile host owners
Settings, registration or a new feature Owning feature's __init__.py and config.ini Feature conventions, extension points
A shared Logistics policy Python/services/ Service owners
Mobile build tooling ownership mobile_build/ Build tooling map
Mobile builds, deployment or native bridges mobile_build/; application source stays under Python/ Mobile handbook
Tests for any of these Python/tests/ or mobile_build/tests/ Test selection and commands

Follow registration factories to the canonical implementation. Feature redirectors have been removed; import the owning module directly. The application feature runtime is features.application.registry. Generated mobile_build/payload/, mobile_build/build/, caches and test reports are outputs; they are not source files to tweak.

Current development references

Read only the contracts relevant to your change. Feature-specific implementation and test maps live in docs/features/<feature>/development/; source-package READMEs link there.

Topic Reference
Feature discovery and infrastructure exceptions Feature infrastructure
Desktop presentation ownership UI architecture
Browser actions, formats and activation Browser extensions
Paths, settings and stored data Configuration and data
Logistics versus reusable library code commonUtils boundary
Documentation locations and compatibility links Documentation hierarchy
Mobile payload manifests and portable imports Mobile preparation
Mobile file/conversation drawers and paired panes Workspace navigation
Mobile build/deployment reference Mobile launchers
Paired iPhone/iPad installation Device deployment
TestFlight archives and uploads TestFlight
Desktop and mobile release gates Releasing, platform checks
Optional external feature hosting Integration boundary
IDE implementation IDE
LM implementation LM
PDF implementation PDF
Encrypted copies and remote browsing LocalCrypt, remote browsing

Validation and evidence

Focused host tests are the everyday starting point. Device interaction and native adapter changes additionally need native validation. These references explain particular checks and record their scope; a past passing report does not validate a new change.

Plans and historical assessments

Use the current audit implementation status for completed units and the remaining native acceptance gate. The history index preserves dated assessments and implementation evidence; old proposed next steps are not today's backlog. Current code and test owners are linked above. Host source lives in Python/desktop/ and Python/mobile/; build tooling lives in mobile_build/.

Documentation to update with a change

Keep all substantive guides in this root wiki. Feature desktop usage belongs in docs/features/<owner>/user/, mobile usage in user_mobile/, and architecture in development/ under the same feature section. Systemic guides keep their existing root audience branches. Update the root README for setup or major capabilities. Package READMEs and user_docs/index.md remain short compatibility links. Shared commonUtils APIs and external feature internals stay in their own wikis. Follow the hierarchy rules and verify consequential claims against source/tests. The older getting-started URL remains a compatibility entry to this guide.

Refactored owner contracts

The current guides cover application composition and lifetimes rather than the former flat modules:

Shared provider, speech, transfer, archive, index and workspace APIs are documented in commonUtils; use the integration boundary.