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

added-doc-about-architecture #101

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

Sukriti-sood
Copy link
Contributor

@Sukriti-sood Sukriti-sood commented Sep 12, 2021

Pull Request Template

Description

Documentation on FLINT Architecture( In progress)

Fixes #76

Type of change

  • This change requires a documentation update

Signed-off-by: Sukriti-sood <soodsukriti1111@gmail.com>
Signed-off-by: Sukriti-sood <soodsukriti1111@gmail.com>
Signed-off-by: Sukriti-sood <soodsukriti1111@gmail.com>
Copy link
Member

@HarshCasper HarshCasper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Sukriti-sood

This actually looks quite good! Thanks for the great work.

Few comments on the same:

  • The docs are not being references anywhere so they are not actually being rendered. You can validate this here: https://moja-global-documentation--101.org.readthedocs.build/en/101/index.html

  • The location for these docs seems to be wrong. They should not be a part of the DeveloperWorkflow as far as I believe.

  • I see some doc pieces like synchronized_events.rst and temporal_distribution.rst left incomplete. Is that intentional?

Signed-off-by: Sukriti-sood <soodsukriti1111@gmail.com>
@Sukriti-sood
Copy link
Contributor Author

Sukriti-sood commented Sep 26, 2021

@HarshCasper

  • docs are here in GitHub workflow section.
  • location of flint-architecture was in the DeveloperWorkflow so, I added them all there.
  • yes, they were left intentionally blank, now reporting_indicato.rst is blank, will update it in some time.

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.

Provide documentation on FLINT Architecture
3 participants