aaif-goose / aaif-goose/goose-mobile

Set instructions in markdown files

Open
#149 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Swift
Stars
163
Forks
33
PR merge metrics
No merged PRs in 30d

Description

Hi,
I went through the code and I noticed how the instructions are set.

I can't help but wonder if it wouldn't be simpler and cleaner to have the instructions set in their respective markdown files rather than hard coding them.

## Advantages
it would not only make the code more approachable but it would also help it make it scalable

## Solution
I'm thinking, achieving that in an optimized way, we would need to read the markdown files during the build process (as a Gradle task), that would set values to variables we can use at runtime.

Contributor guide

Open the contributing guide

Research direction

Look at the current hardcoded instructions in the Swift codebase. Identify the Gradle build configuration for the mobile project. Research how to read markdown files during a Gradle build task and pass those values as variables to the Swift runtime. The goal is to replace hardcoded strings with content loaded from markdown files.

Written by the indexing model from the issue text.

Assessment

Domain
build-system
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.