Skip to content

docs(readme): update readme files#533

Merged
r0ssing merged 1 commit intoOpenDataEnsemble:devfrom
Bahati308:docUpdate
Mar 20, 2026
Merged

docs(readme): update readme files#533
r0ssing merged 1 commit intoOpenDataEnsemble:devfrom
Bahati308:docUpdate

Conversation

@Bahati308
Copy link
Contributor

@Bahati308 Bahati308 commented Mar 20, 2026

docs(readme): update readme files

Description

  • This PR updates the README files to have a well organised flow and remove the repeated info by referencing the available documents.

Type of Change

  • Bug Fix
  • New Feature / Enhancement
  • Refactor / Code Cleanup
  • Documentation Update
  • Maintenance / Chore
  • Other (please specify):

Component(s) Affected

  • formulus (React Native mobile app)
  • formulus-formplayer (React web app)
  • synkronus (Go backend server)
  • synkronus-cli (Command-line utility)
  • Documentation
  • DevOps / CI/CD
  • Other:

Related Issue(s)

Closes/Fixes/Resolves:


Testing

  • Unit tests added/updated
  • Integration tests added/updated
  • Manually tested
  • Tested on multiple platforms (if applicable)
  • Not applicable

Breaking Changes

  • This PR introduces breaking changes
  • This PR does NOT introduce breaking changes

If breaking changes, please describe migration steps:


Documentation Updates

  • Documentation has been updated
  • Documentation update is not required

Checklist

  • Code follows project style guidelines
  • All existing tests pass
  • New tests added for new functionality
  • PR title follows Conventional Commits format

Thank you for contributing to Open Data Ensemble (ODE)!

@Bahati308 Bahati308 changed the title Update (README) files to match the latest info in the codebase Update (README): files to match the latest info in the codebase Mar 20, 2026
@Bahati308 Bahati308 changed the title Update (README): files to match the latest info in the codebase docs (readme): Update README files Mar 20, 2026
@Bahati308 Bahati308 changed the title docs (readme): Update README files docs(readme): update readme files Mar 20, 2026
@Bahati308 Bahati308 requested a review from r0ssing March 20, 2026 06:50
@Bahati308 Bahati308 self-assigned this Mar 20, 2026
@IamLRBA IamLRBA self-requested a review March 20, 2026 10:58
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!

@r0ssing r0ssing merged commit 7c8b2ee into OpenDataEnsemble:dev Mar 20, 2026
16 of 19 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