Skip to content

Commit 10d2591

Browse files
author
Lalit Sharma
committed
chore(release): reorganize docs and pause Wear Play submission
- restructure `documents/` into `guides/`, `planning/`, and `reference/` - add new guides for setup, contributing, deployment, troubleshooting, and performance - update `documents/README.md` and add `documents/REORGANIZATION.md` - temporarily disable Wear artifact validation/release asset/upload steps in `.github/workflows/eas-build.yml` - bump `apps/mobile` version to `1.1.8` and update root `CHANGELOG.md`
1 parent 308b102 commit 10d2591

20 files changed

Lines changed: 1247 additions & 59 deletions

.github/workflows/eas-build.yml

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -458,10 +458,11 @@ jobs:
458458
exit 1
459459
fi
460460
461-
if [ ! -f "$artifact_root/$wear_aab_asset" ]; then
462-
echo "Missing Wear OS artifact at $artifact_root/$wear_aab_asset."
463-
exit 1
464-
fi
461+
# Wear OS artifact validation disabled for now
462+
# if [ ! -f "$artifact_root/$wear_aab_asset" ]; then
463+
# echo "Missing Wear OS artifact at $artifact_root/$wear_aab_asset."
464+
# exit 1
465+
# fi
465466
466467
- name: Prepare GitHub release assets
467468
id: release_assets
@@ -474,7 +475,6 @@ jobs:
474475
echo "artifacts/submission/${{ steps.artifact_names.outputs.ios }}"
475476
echo "artifacts/submission/${{ steps.artifact_names.outputs.android_aab }}"
476477
echo "artifacts/submission/${{ steps.artifact_names.outputs.android_apk }}"
477-
echo "artifacts/submission/${{ steps.artifact_names.outputs.wear_aab }}"
478478
echo "EOF"
479479
} >> "$GITHUB_OUTPUT"
480480
@@ -700,24 +700,25 @@ jobs:
700700
releaseFiles: artifacts/submission/${{ steps.artifact_names.outputs.android_aab }}
701701
track: internal
702702

703-
- name: Upload Wear OS artifact to Google Play (with notes)
704-
if: ${{ steps.store_notes.outputs.has_store_notes == 'true' }}
705-
uses: r0adkll/upload-google-play@v1
706-
with:
707-
serviceAccountJsonPlainText: ${{ secrets.GOOGLE_PLAY_SERVICE_ACCOUNT_JSON }}
708-
packageName: com.lallimaven.eclipsetimer.wear
709-
releaseFiles: artifacts/submission/${{ steps.artifact_names.outputs.wear_aab }}
710-
track: internal
711-
whatsNewDirectory: ${{ steps.store_notes.outputs.play_whatsnew_dir }}
712-
713-
- name: Upload Wear OS artifact to Google Play
714-
if: ${{ steps.store_notes.outputs.has_store_notes != 'true' }}
715-
uses: r0adkll/upload-google-play@v1
716-
with:
717-
serviceAccountJsonPlainText: ${{ secrets.GOOGLE_PLAY_SERVICE_ACCOUNT_JSON }}
718-
packageName: com.lallimaven.eclipsetimer.wear
719-
releaseFiles: artifacts/submission/${{ steps.artifact_names.outputs.wear_aab }}
720-
track: internal
703+
# TODO: Re-enable Wear OS uploads once the package is set up in Google Play Store
704+
# - name: Upload Wear OS artifact to Google Play (with notes)
705+
# if: ${{ steps.store_notes.outputs.has_store_notes == 'true' }}
706+
# uses: r0adkll/upload-google-play@v1
707+
# with:
708+
# serviceAccountJsonPlainText: ${{ secrets.GOOGLE_PLAY_SERVICE_ACCOUNT_JSON }}
709+
# packageName: com.lallimaven.eclipsetimer.wear
710+
# releaseFiles: artifacts/submission/${{ steps.artifact_names.outputs.wear_aab }}
711+
# track: internal
712+
# whatsNewDirectory: ${{ steps.store_notes.outputs.play_whatsnew_dir }}
713+
#
714+
# - name: Upload Wear OS artifact to Google Play
715+
# if: ${{ steps.store_notes.outputs.has_store_notes != 'true' }}
716+
# uses: r0adkll/upload-google-play@v1
717+
# with:
718+
# serviceAccountJsonPlainText: ${{ secrets.GOOGLE_PLAY_SERVICE_ACCOUNT_JSON }}
719+
# packageName: com.lallimaven.eclipsetimer.wear
720+
# releaseFiles: artifacts/submission/${{ steps.artifact_names.outputs.wear_aab }}
721+
# track: internal
721722

722723
- name: Create GitHub release with mobile artifacts
723724
uses: softprops/action-gh-release@v2

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.1.8] — 2026-02-21
9+
10+
### Added
11+
- Added a new docs guide set under `documents/guides/`: setup and development, contributing, deployment, troubleshooting, and performance optimization.
12+
- Added `documents/REORGANIZATION.md` to document the new documentation layout and migration summary.
13+
14+
### Changed
15+
- Reorganized `documents/` into purpose-based sections (`guides/`, `planning/`, `reference/`) and updated `documents/README.md` with quick-start, role-based reading paths, and maintenance standards.
16+
- Updated `.github/workflows/eas-build.yml` to temporarily disable Wear OS artifact validation, release asset packaging, and Google Play upload steps until the Wear package is ready in Play Console.
17+
818
## [1.1.7] — 2026-02-21
919

1020
### Changed

apps/mobile/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@eclipse-timer/mobile",
3-
"version": "1.1.7",
3+
"version": "1.1.8",
44
"private": true,
55
"main": "index.js",
66
"scripts": {

documents/README.md

Lines changed: 108 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,113 @@
11
# Eclipse Timer Documentation
22

3-
This folder contains the project documentation for the `eclipse-timer` monorepo.
3+
This folder contains comprehensive documentation for the Eclipse Timer project—a monorepo for calculating and visualizing eclipse circumstances.
4+
5+
## Quick Start
6+
7+
**New to the project?** Start here:
8+
9+
1. [Setup and Development](guides/setup-and-development.md) – Install and configure your environment
10+
2. [System Overview](high-level/system-overview.md) – Understand the architecture
11+
3. [Contributing Guide](guides/contributing.md) – Learn how to make changes
412

513
## Documentation Map
614

7-
### Planning
8-
- `documents/01-documentation-plan.md`
9-
- `documents/CHANGELOG.md`
10-
- `documents/in-app-alarm-rework-plan.md`
11-
- `documents/release-plan-eas.md`
12-
- `documents/self-hosted-macos-runner.md`
13-
- `documents/wearable-companion-implementation-plan.md`
14-
15-
### High-Level
16-
- `documents/high-level/system-overview.md`
17-
- Includes Mermaid component and sequence architecture diagrams.
18-
- `documents/high-level/user-flow-and-product-behavior.md`
19-
- `documents/high-level/development-workflow.md`
20-
- `documents/high-level/wearable-companion-requirements.md`
21-
22-
### Low-Level
23-
- `documents/low-level/mobile-app-internals.md`
24-
- `documents/low-level/engine-algorithm.md`
25-
- `documents/low-level/data-contracts.md`
26-
- `documents/low-level/wearable-companion-technical-design.md`
27-
28-
## Reading Order
29-
1. `documents/high-level/system-overview.md`
30-
2. `documents/high-level/user-flow-and-product-behavior.md`
31-
3. `documents/low-level/data-contracts.md`
32-
4. `documents/low-level/engine-algorithm.md`
33-
5. `documents/low-level/mobile-app-internals.md`
34-
6. `documents/high-level/wearable-companion-requirements.md`
35-
7. `documents/low-level/wearable-companion-technical-design.md`
36-
37-
## Maintenance
38-
- Update high-level docs when package boundaries, app behavior, or scripts change.
39-
- Update low-level docs whenever equations, types, or state transitions change.
40-
- Prefer linking to code paths as source of truth.
15+
### Guides (How-To)
16+
- [Setup and Development](guides/setup-and-development.md) – Installation, common commands, monorepo workflow
17+
- [Contributing Guide](guides/contributing.md) – Code style, testing, submission process
18+
- [Deployment Guide](guides/deployment.md) – Building for release, EAS, app store submission
19+
- [Troubleshooting Guide](guides/troubleshooting.md) – Common issues and solutions
20+
- [Performance Optimization](guides/performance-optimization.md) – Profiling, bottlenecks, and optimization
21+
22+
### High-Level Documentation (Architecture & Behavior)
23+
- [System Overview](high-level/system-overview.md) – Monorepo structure, package boundaries, data flow
24+
- [User Flow and Product Behavior](high-level/user-flow-and-product-behavior.md) – User interactions, app states, screens
25+
- [Wearable Companion Requirements](high-level/wearable-companion-requirements.md) – Requirements and design for wearable integration
26+
27+
### Low-Level Documentation (Implementation Details)
28+
- [Data Contracts](low-level/data-contracts.md) – TypeScript types, catalog schema, data structures
29+
- [Engine Algorithm](low-level/engine-algorithm.md) – Eclipse calculations, math, root solving
30+
- [Mobile App Internals](low-level/mobile-app-internals.md) – React state, handlers, UI integration
31+
- [Wearable Technical Design](low-level/wearable-companion-technical-design.md) – Implementation details for wearable
32+
33+
### Planning & Tracking
34+
- [Documentation Plan](planning/01-documentation-plan.md) – Goals, standards, and maintenance triggers
35+
- [In-App Alarm Rework Plan](planning/in-app-alarm-rework-plan.md) – Alarm system redesign proposal
36+
- [Wearable Implementation Plan](planning/wearable-companion-implementation-plan.md) – Wearable rollout phases
37+
- [Release Plan (EAS)](planning/release-plan-eas.md) – EAS build and release strategy
38+
- [Self-Hosted macOS Runner](planning/self-hosted-macos-runner.md) – CI/CD setup for native builds
39+
- [Tech Debt](planning/tech-debt.md) – Known issues and improvement areas
40+
41+
### Reference
42+
- [CHANGELOG](reference/CHANGELOG.md) – Release history and version notes
43+
- [Store Metadata](reference/store-metadata.md) – App store descriptions, screenshots, keywords
44+
- [Store Privacy Declarations](reference/store-privacy-declarations.md) – Privacy policy and data handling
45+
- [Testing Scenarios](reference/testing-scenarios.md) – QA test cases and edge cases
46+
47+
## Reading Paths by Role
48+
49+
### Product Owner / Project Manager
50+
1. [System Overview](high-level/system-overview.md)
51+
2. [User Flow and Product Behavior](high-level/user-flow-and-product-behavior.md)
52+
3. [Wearable Companion Requirements](high-level/wearable-companion-requirements.md)
53+
4. [Planning documents](planning/) as needed
54+
55+
### Mobile App Developer
56+
1. [Setup and Development](guides/setup-and-development.md)
57+
2. [System Overview](high-level/system-overview.md)
58+
3. [User Flow and Product Behavior](high-level/user-flow-and-product-behavior.md)
59+
4. [Mobile App Internals](low-level/mobile-app-internals.md)
60+
5. [Data Contracts](low-level/data-contracts.md)
61+
62+
### Engine / Math Developer
63+
1. [Setup and Development](guides/setup-and-development.md)
64+
2. [System Overview](high-level/system-overview.md)
65+
3. [Engine Algorithm](low-level/engine-algorithm.md)
66+
4. [Data Contracts](low-level/data-contracts.md)
67+
68+
### Catalog / Data Developer
69+
1. [Setup and Development](guides/setup-and-development.md)
70+
2. [Data Contracts](low-level/data-contracts.md)
71+
3. [Store Metadata](reference/store-metadata.md)
72+
73+
### QA / Tester
74+
1. [Testing Scenarios](reference/testing-scenarios.md)
75+
2. [Troubleshooting Guide](guides/troubleshooting.md)
76+
3. [Deployment Guide](guides/deployment.md) (for release testing)
77+
78+
### Release Manager / DevOps
79+
1. [Deployment Guide](guides/deployment.md)
80+
2. [Release Plan (EAS)](planning/release-plan-eas.md)
81+
3. [Self-Hosted macOS Runner](planning/self-hosted-macos-runner.md)
82+
83+
## Documentation Standards
84+
85+
- **Units are explicit**: Always include units (`hours`, `seconds`, `degrees`, `meters`, `UTC`)
86+
- **Current behavior first**: Document what is, mark future or placeholder logic clearly
87+
- **Code is source of truth**: Include direct file/line references to code
88+
- **Examples are aligned**: Use `packages/catalog/src/catalog.sample.json` for examples
89+
- **Searchable**: Use clear headings and organization
90+
91+
## When to Update Docs
92+
93+
Update documentation whenever these change:
94+
95+
- **Types**: `packages/shared/src/types.ts`
96+
- **Engine**: `packages/engine/src/circumstances/compute.ts`, `functions.ts`
97+
- **Mobile App**: `apps/mobile/src/App.tsx`, navigation, state management
98+
- **Setup**: Root `package.json` scripts, `pnpm-workspace.yaml`, or `.env` files
99+
- **User flows**: Major UI changes, new screens, or state transitions
100+
101+
See [Documentation Plan](planning/01-documentation-plan.md) for more details.
102+
103+
## Contributing to Docs
104+
105+
1. Use Markdown formatting for clarity
106+
2. Link to related sections and external resources
107+
3. Include code examples where helpful
108+
4. Update the [Documentation Plan](planning/01-documentation-plan.md) if adding new docs
109+
5. Keep the main README synchronized
110+
111+
---
112+
113+
**Have questions?** See [Troubleshooting Guide](guides/troubleshooting.md) or check relevant deep-dive documentation.

documents/REORGANIZATION.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# Documentation Reorganization Summary
2+
3+
## What Changed
4+
5+
The `/documents` folder has been reorganized from a flat structure into a logical, category-based hierarchy. This improves discoverability and makes it easier for contributors to find relevant documentation.
6+
7+
### Old Structure
8+
```
9+
documents/
10+
├── README.md
11+
├── 01-documentation-plan.md
12+
├── CHANGELOG.md
13+
├── in-app-alarm-rework-plan.md
14+
├── release-plan-eas.md
15+
├── self-hosted-macos-runner.md
16+
├── store-metadata.md
17+
├── store-privacy-declarations.md
18+
├── tech-debt.md
19+
├── testing-scenarios.md
20+
├── wearable-companion-implementation-plan.md
21+
├── high-level/
22+
└── low-level/
23+
```
24+
25+
### New Structure
26+
```
27+
documents/
28+
├── README.md (updated with new organization)
29+
├── guides/ (NEW)
30+
│ ├── setup-and-development.md (NEW)
31+
│ ├── contributing.md (NEW)
32+
│ ├── deployment.md (NEW)
33+
│ ├── troubleshooting.md (NEW)
34+
│ └── performance-optimization.md (NEW)
35+
├── high-level/ (existing)
36+
│ ├── development-workflow.md
37+
│ ├── system-overview.md
38+
│ ├── user-flow-and-product-behavior.md
39+
│ └── wearable-companion-requirements.md
40+
├── low-level/ (existing)
41+
│ ├── data-contracts.md
42+
│ ├── engine-algorithm.md
43+
│ ├── mobile-app-internals.md
44+
│ └── wearable-companion-technical-design.md
45+
├── planning/ (NEW)
46+
│ ├── 01-documentation-plan.md
47+
│ ├── in-app-alarm-rework-plan.md
48+
│ ├── release-plan-eas.md
49+
│ ├── self-hosted-macos-runner.md
50+
│ ├── tech-debt.md
51+
│ └── wearable-companion-implementation-plan.md
52+
└── reference/ (NEW)
53+
├── CHANGELOG.md
54+
├── store-metadata.md
55+
├── store-privacy-declarations.md
56+
└── testing-scenarios.md
57+
```
58+
59+
## New Folders
60+
61+
### 📖 `guides/` - How-To Documentation
62+
Practical guides for developers, maintainers, and contributors:
63+
64+
- **setup-and-development.md** – Installation, common commands, monorepo workflow
65+
- **contributing.md** – Code style, testing, and submission guidelines
66+
- **deployment.md** – Building for release, EAS, app store submission
67+
- **troubleshooting.md** – Common issues and solutions
68+
- **performance-optimization.md** – Profiling, bottlenecks, and optimization tips
69+
70+
### 📋 `planning/` - Planning & Proposals
71+
Project planning documents, proposals, and tracking:
72+
73+
- **01-documentation-plan.md** – Documentation goals and standards
74+
- **in-app-alarm-rework-plan.md** – Alarm system redesign proposal
75+
- **wearable-companion-implementation-plan.md** – Wearable integration phases
76+
- **release-plan-eas.md** – EAS build and release strategy
77+
- **self-hosted-macos-runner.md** – CI/CD setup for native builds
78+
- **tech-debt.md** – Known issues and improvement areas
79+
80+
### 📚 `reference/` - Reference Material
81+
Metadata, release notes, and compliance documentation:
82+
83+
- **CHANGELOG.md** – Release history and version notes
84+
- **store-metadata.md** – App store descriptions and keywords
85+
- **store-privacy-declarations.md** – Privacy policy and data handling
86+
- **testing-scenarios.md** – QA test cases and edge cases
87+
88+
## New Stub Documents Created
89+
90+
The following new documents were created as starting points and should be refined over time:
91+
92+
1. **guides/setup-and-development.md** – Refactored from high-level/development-workflow.md
93+
2. **guides/contributing.md** – New contributor guide with code style and workflow
94+
3. **guides/deployment.md** – Complete guide for building and releasing
95+
4. **guides/troubleshooting.md** – Comprehensive troubleshooting for all layers
96+
5. **guides/performance-optimization.md** – Profiling and optimization strategies
97+
98+
## Benefits
99+
100+
**Better Organization** – Documents are grouped by purpose, not just type
101+
**Faster Discovery** – Readers find what they need by category
102+
**Clear Paths** – README now provides role-based reading paths
103+
**Easier Maintenance** – Related docs live together
104+
**Scalable** – New guides/reference docs fit naturally into existing structure
105+
**Comprehensive** – Filled gaps in documentation (setup, deployment, troubleshooting)
106+
107+
## What Didn't Change
108+
109+
- **high-level/** – All architecture and behavior docs remain as-is
110+
- **low-level/** – All implementation and algorithm docs remain as-is
111+
- **Document content** – No existing content was modified (only organization)
112+
113+
## Next Steps
114+
115+
1. **Review** the new guides to ensure they meet your team's needs
116+
2. **Update** guides/setup-and-development.md if development workflow differs
117+
3. **Customize** guides/deployment.md with your team's specific deployment process
118+
4. **Link** the main README in your root repo if there's one
119+
5. **Communicate** the new structure to your team
120+
121+
---
122+
123+
For questions or updates to the documentation structure, see [README.md](README.md) and [planning/01-documentation-plan.md](planning/01-documentation-plan.md).

0 commit comments

Comments
 (0)