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 protodoc-markdown.tmpl #528

Merged
merged 5 commits into from
Jun 20, 2023
Merged

added protodoc-markdown.tmpl #528

merged 5 commits into from
Jun 20, 2023

Conversation

vertex451
Copy link
Contributor

@vertex451 vertex451 commented Jun 19, 2023

This change is Reviewable

@vertex451 vertex451 requested a review from a team as a code owner June 19, 2023 09:58
@vertex451 vertex451 requested review from dzmitryhil, miladz68, ysv and wojtek-coreum and removed request for a team June 19, 2023 09:58
Copy link
Contributor

@dzmitryhil dzmitryhil left a comment

Choose a reason for hiding this comment

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

Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on @miladz68, @silverspase, @wojtek-coreum, and @ysv)


docs/protodoc-markdown.tmpl line 1 at r1 (raw file):

<!-- This file is auto-generated. Please do not modify it yourself. -->

@silverspase @wojtek-coreum @miladz68 Should it be a part of the coreum or crust if the crust uses it for the generation, WDYT ?

Copy link
Contributor Author

@vertex451 vertex451 left a comment

Choose a reason for hiding this comment

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

Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on @miladz68, @wojtek-coreum, and @ysv)


docs/protodoc-markdown.tmpl line 1 at r1 (raw file):

Previously, dzmitryhil (Dzmitry Hil) wrote…

@silverspase @wojtek-coreum @miladz68 Should it be a part of the coreum or crust if the crust uses it for the generation, WDYT ?

We can put it into the crust, but for this, we will pull the crust repo(ensure) for docs generation.
Second point - output will be placed into the Coreum repo, so it would be logical to keep input within this repo as well.

I would have the template in the Coreum repo.

Copy link
Contributor

@miladz68 miladz68 left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @wojtek-coreum and @ysv)


docs/protodoc-markdown.tmpl line 1 at r1 (raw file):

Previously, silverspase (Artem) wrote…

We can put it into the crust, but for this, we will pull the crust repo(ensure) for docs generation.
Second point - output will be placed into the Coreum repo, so it would be logical to keep input within this repo as well.

I would have the template in the Coreum repo.

I think it should be here, since the logic for how it should be structured is not part of crust.

Copy link
Contributor

@dzmitryhil dzmitryhil left a comment

Choose a reason for hiding this comment

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

Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @wojtek-coreum and @ysv)


docs/protodoc-markdown.tmpl line 1 at r1 (raw file):

Previously, miladz68 (milad) wrote…

I think it should be here, since the logic for how it should be structured is not part of crust.

I'm ok then.

Copy link
Contributor

@dzmitryhil dzmitryhil left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @wojtek-coreum and @ysv)

@vertex451 vertex451 merged commit 2be09f4 into master Jun 20, 2023
@vertex451 vertex451 deleted the artem/generate-proto-doc branch June 20, 2023 10:43
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