Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix hyperlinks docs #138

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions docs/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,15 @@

This toolkit consists of three components.

The first component ([](/src/rpft/parsers/common)) is RapidPro-agnostic and takes care of reader spreadsheets and converting them into internal data models and other output formats, see [](sheets.md)
[rpft.parsers.common] is RapidPro-agnostic and takes care of reader spreadsheets and converting them into internal data models and other output formats, see [sheets documentation](sheets.md).

The second component ([](/src/rpft/parsers/creation)) defines data models for a spreadsheet format for RapidPro flows, and process spreadsheets into RapidPro flows (and back) using the first component.
[rpft.parsers.creation] defines data models for a spreadsheet format for RapidPro flows, and process spreadsheets into RapidPro flows (and back) using the first component.

The third component ([](/src/rpft/rapidpro)) defines internal representations of RapidPro flows and to read and write to a JSON format that can be import to/exported from RapidPro. It is partially entangled with the second component, as it needs to be aware of the data models of the second component to convert RapidPro flows into the spreadsheet format.
[rpft.rapidpro] defines internal representations of RapidPro flows and to read and write to a JSON format that can be import to/exported from RapidPro. It is partially entangled with `rpft.parsers.creation` as it needs to be aware of the data models of the creation component to convert RapidPro flows into the spreadsheet format.

The latter two components are (poorly) documented here: [](rapidpro.md)
The latter two components are [documented](rapidpro.md).


[rpft.parsers.common]: /src/rpft/parsers/common
[rpft.parsers.creation]: /src/rpft/parsers/creation
[rpft.rapidpro]: /src/rpft/rapidpro
Loading