Is your feature request related to a problem? Please describe.
Documents are currently viewed on the Data Science Knowledge Base via GitHub API calls to render contents, replicating the structure used within this repo, and directly created from the markdown. This causes issues and limits the metrics that can be displayed or used to filter documents on the app. Additionally, reviewing the documentation is currently a manual process, resulting in stale documents and risks where changes could break links.
Describe what you'd like
To be determined following review of documentation and repo/app architecture.
As a first step, creating a documentation database and adding YAML to each document, allowing the inclusion of variables that can be used in the app, will improve the maintainability and performance of the app just. The generation of this data will also allow more detailed analysis of the technical documents, including contents, and related documents. The identified improvements from this analysis can then iteratively be added as features to the Knowledge Base.
The information created here will then be possible to link back into the app development, generating structures and linking features to the database rather than relying on the data returned via the API.
Is your feature request related to a problem? Please describe.
Documents are currently viewed on the Data Science Knowledge Base via GitHub API calls to render contents, replicating the structure used within this repo, and directly created from the markdown. This causes issues and limits the metrics that can be displayed or used to filter documents on the app. Additionally, reviewing the documentation is currently a manual process, resulting in stale documents and risks where changes could break links.
Describe what you'd like
To be determined following review of documentation and repo/app architecture.
As a first step, creating a documentation database and adding YAML to each document, allowing the inclusion of variables that can be used in the app, will improve the maintainability and performance of the app just. The generation of this data will also allow more detailed analysis of the technical documents, including contents, and related documents. The identified improvements from this analysis can then iteratively be added as features to the Knowledge Base.
The information created here will then be possible to link back into the app development, generating structures and linking features to the database rather than relying on the data returned via the API.