Skip to content

Conversation

@Mishael-2584
Copy link
Contributor

@Mishael-2584 Mishael-2584 commented Jan 15, 2026

Description

This PR enhances the Formulus installation documentation with detailed step-by-step instructions, screenshots, and corrects the installation workflow to reflect that F-Droid is used to install Obtainium, which then installs Formulus (including pre-release versions).

Type of Change

  • Documentation update
  • Bug fix
  • New feature
  • Breaking change

Components Affected

  • Documentation (docs/getting-started/installing-formulus.md)
  • Versioned documentation (versioned_docs/version-1.0/getting-started/installing-formulus.md)
  • Static assets (static/img/installation/)
  • Docusaurus plugins (plugins/fix-docs-links.js, plugins/fix-docs-links-rehype.js)

Related Issue(s)

N/A - Documentation enhancement

Changes Made

Core Implementation

  1. Restructured Installation Methods:

    • Method 1: Obtainium (Recommended) - Now the primary installation method
      • Option A: Install Obtainium via F-Droid (with detailed F-Droid installation steps)
      • Option B: Install Obtainium directly from GitHub
      • Step-by-step instructions for adding ODE repository to Obtainium
      • Detailed Formulus installation via Obtainium
    • Method 2: Direct APK Installation - Alternative method
    • Method 3: Development Build - For developers
  2. Added 8 Installation Screenshots:

    • f-droid-download.png - F-Droid download page
    • obtainium-install.png - Obtainium installation confirmation
    • obtainium-add-app.png - Adding ODE repository to Obtainium
    • obtainium-ode-details.png - ODE app details in Obtainium
    • formulus-install-dialog.png - Formulus installation confirmation dialog
    • formulus-app-search.png - Finding Formulus app after installation
    • enable-unknown-sources.png - Android settings for enabling unknown sources
    • obtainium-repo-add.png - Repository addition (available but not currently referenced)
  3. Corrected Installation Workflow:

    • Clarified that F-Droid is used to install Obtainium, not Formulus directly
    • Updated all references to reflect the correct workflow: F-Droid → Obtainium → Formulus
    • Removed incorrect F-Droid → Formulus installation instructions
  4. Enhanced Instructions:

    • Detailed step-by-step instructions with specific UI elements highlighted
    • Added emphasis on enabling "Include prereleases" toggle for alpha/beta versions
    • Included app icon descriptions for easier identification
    • Added troubleshooting section for Obtainium-specific issues
  5. Updated Both Latest and Versioned Docs:

    • Updated docs/getting-started/installing-formulus.md (latest)
    • Updated versioned_docs/version-1.0/getting-started/installing-formulus.md (v1.0)

Technical Details

  • All images are properly referenced using absolute paths (/img/installation/...)
  • Images are stored in static/img/installation/ directory
  • Docusaurus link fix plugins are included (from previous work)
  • All internal documentation links use relative paths
  • All external links use absolute URLs

Testing

Manual Testing

  • Verified all image files exist in static/img/installation/
  • Verified all image references in markdown are correct
  • Verified no broken internal links
  • Verified external links are valid
  • Tested documentation renders correctly in Docusaurus dev server
  • Verified both latest and versioned docs are updated

Browser Testing

  • Confirmed images are accessible at /img/installation/... paths
  • Verified page content displays correctly
  • Confirmed images render properly in documentation

Breaking Changes

None - This is a documentation-only update.

Documentation Updates

  • Enhanced installation guide with visual aids (screenshots)
  • Corrected installation workflow documentation
  • Added detailed Obtainium installation and usage instructions
  • Updated troubleshooting section with Obtainium-specific guidance

Files Modified

Documentation Files

  • docs/getting-started/installing-formulus.md - Enhanced with screenshots and corrected workflow
  • versioned_docs/version-1.0/getting-started/installing-formulus.md - Updated to match latest version

New Files

  • static/img/installation/f-droid-download.png
  • static/img/installation/obtainium-install.png
  • static/img/installation/obtainium-add-app.png
  • static/img/installation/obtainium-ode-details.png
  • static/img/installation/formulus-install-dialog.png
  • static/img/installation/formulus-app-search.png
  • static/img/installation/enable-unknown-sources.png
  • static/img/installation/obtainium-repo-add.png
  • plugins/fix-docs-links.js (from previous work)
  • plugins/fix-docs-links-rehype.js (from previous work)

Impact

  • User Experience: Significantly improved with visual guides and clearer instructions
  • Accuracy: Corrected workflow ensures users follow the correct installation path
  • Completeness: All installation methods now have comprehensive documentation with screenshots

Checklist

  • Documentation is clear and accurate
  • All images are properly referenced and exist
  • No broken links (internal or external)
  • Both latest and versioned docs are updated
  • Code follows project documentation standards
  • Changes have been tested locally
  • Branch is ready for review

Screenshots

The PR includes 8 installation screenshots that guide users through:

  1. Downloading F-Droid
  2. Installing Obtainium
  3. Adding ODE repository to Obtainium
  4. Viewing ODE app details
  5. Confirming Formulus installation
  6. Finding Formulus after installation
  7. Enabling unknown sources on Android
  8. Repository addition process

@Mishael-2584 Mishael-2584 requested a review from r0ssing January 15, 2026 14:50
Copy link
Contributor

@r0ssing r0ssing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! I really like the cleaned up screenshots. That's super helpful! Thanks @Mishael-2584

@Mishael-2584 Mishael-2584 merged commit 31a316d into main Jan 15, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants