Skip to content

Commit 2886ece

Browse files
committed
Add docs section and backlinks
1 parent 9a11b70 commit 2886ece

File tree

4 files changed

+22
-12
lines changed

4 files changed

+22
-12
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
[![Build Status](https://github.com/afarber/OpenMapView/actions/workflows/ci.yml/badge.svg)](https://github.com/afarber/OpenMapView/actions/workflows/ci.yml)
22

3-
[![Spotless](https://github.com/afarber/OpenMapView/actions/workflows/spotless.yml/badge.svg)](https://github.com/afarber/OpenMapView/actions/workflows/spotless.yml)
4-
53
# OpenMapView
64

75
A modern, Kotlin-first MapView replacement for Android — powered by [OpenStreetMap](https://www.openstreetmap.org/).
@@ -36,6 +34,12 @@ Shows zoom functionality with FAB controls and pinch-to-zoom gestures.
3634

3735
Demonstrates marker system with custom icons and click handling.
3836

37+
## Documentation
38+
39+
- [Lifecycle Management](docs/LIFECYCLE.md) - How OpenMapView handles Android lifecycle events
40+
- [Maven Central Setup](docs/MAVEN_CENTRAL_SETUP.md) - Publishing configuration and release process
41+
- [GitHub Workflows](docs/GITHUB_WORKFLOWS.md) - CI/CD pipeline and workflow architecture
42+
3943
## Getting Started
4044

4145
### With Jetpack Compose

docs/GITHUB_WORKFLOWS.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# GitHub Actions Workflows Guide
22

3+
[Back to README](../README.md)
4+
35
This document explains the GitHub Actions workflows used in the OpenMapView project.
46

57
## Architecture Overview
@@ -131,19 +133,19 @@ build-library build-examples
131133

132134
## Required GitHub Secrets
133135

134-
For the release workflow to function, you must configure these secrets in your GitHub repository:
136+
For the release workflow to function, the project owner must configure these secrets in the GitHub repository:
135137

136138
**Location**: Settings -> Secrets and variables -> Actions -> Repository secrets
137139

138140
### 1. OSSRH_USERNAME
139-
- **Description**: Your Sonatype JIRA username
141+
- **Description**: Sonatype JIRA username
140142
- **Used for**: Authenticating to Maven Central OSSRH
141-
- **How to get**: Created when you register at https://issues.sonatype.org
143+
- **How to get**: Created when registering at https://issues.sonatype.org
142144

143145
### 2. OSSRH_PASSWORD
144-
- **Description**: Your Sonatype JIRA password
146+
- **Description**: Sonatype JIRA password
145147
- **Used for**: Authenticating to Maven Central OSSRH
146-
- **How to get**: Set when you register at https://issues.sonatype.org
148+
- **How to get**: Set when registering at https://issues.sonatype.org
147149

148150
### 3. SIGNING_KEY
149151
- **Description**: Base64-encoded GPG private key
@@ -156,10 +158,10 @@ For the release workflow to function, you must configure these secrets in your G
156158
- **Security**: Never commit this or share it publicly
157159

158160
### 4. SIGNING_PASSWORD
159-
- **Description**: Passphrase for your GPG key
161+
- **Description**: Passphrase for the GPG key
160162
- **Used for**: Unlocking the GPG private key for signing
161-
- **How to get**: The passphrase you set when creating your GPG key
162-
- **Note**: If you didn't set a passphrase, use an empty string
163+
- **How to get**: The passphrase set when creating the GPG key
164+
- **Note**: If no passphrase was set, use an empty string
163165

164166
### Automatic Secrets
165167

@@ -172,7 +174,7 @@ These secrets are automatically provided by GitHub Actions:
172174

173175
### Running CI Checks Locally
174176

175-
Before pushing, you can run the same checks locally:
177+
Before pushing, developers can run the same checks locally:
176178

177179
```bash
178180
# Format check

docs/LIFECYCLE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# OpenMapView Lifecycle Management
22

3+
[Back to README](../README.md)
4+
35
This document explains how OpenMapView handles Android lifecycle events and compares it with Google's MapView approach.
46

57
## Why Lifecycle Management Matters

docs/MAVEN_CENTRAL_SETUP.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Maven Central Publishing Setup Guide
22

3+
[Back to README](../README.md)
4+
35
This guide documents the Maven Central publishing setup for OpenMapView.
46

57
## Current Status
68

7-
**Setup Complete** - OpenMapView is configured to publish to Maven Central.
9+
**Setup Complete** - OpenMapView is configured to publish to Maven Central.
810

911
- **Namespace**: `de.afarber` (verified with Sonatype)
1012
- **Group ID**: `de.afarber`

0 commit comments

Comments
 (0)