Fix Documentation Generation on our CI

Galdineris commented 3 years ago

Motivation

Closes #14 Our directory was confusing and classes presented ambiguous names.

Modifications

Renamed workflow files
Renamed classes and files to less ambiguous names
Removed previously generated docs folder
Created new Update Documentation workflow
Moved data structure files into their respective domain folders
Moved all manual artefacts to new Resources folder

Result

Our CI now generates documentation automatically when pushing to master. Folder and files structure more clearly separated by domain.

Checklist

This PR is

[x] In accordance with our coding principles.
[x] Implementing tests wherever needed and possible.
[x] Free of commented code.
[x] Documented.
[x] Closing an Issue or related to an Issue
[x] Approved in the CI

Galdineris commented 3 years ago

@EdgSgroi @VicFalcetta I reverted the name to "singleLine" due to the UI components structure (Which used SingleLine nomenclature). The change to "PlainText" also implied using the same object for both single line and multi line components (refactoring their operation). Changing the name to PlainText without that could result in confusion between PlainText and MultiLine.

EdgSgroi commented 3 years ago

@Galdineris Let's discuss this better in a team meeting. Just because we aren't aligned.

MyFormworks / Formworks