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

Improve documentation integration #57

Closed
3 of 4 tasks
valiafetisov opened this issue Jun 28, 2023 · 1 comment · Fixed by #58
Closed
3 of 4 tasks

Improve documentation integration #57

valiafetisov opened this issue Jun 28, 2023 · 1 comment · Fixed by #58
Assignees

Comments

@valiafetisov
Copy link
Contributor

valiafetisov commented Jun 28, 2023

Goal

Implement dynamic document-model-libs documentation

Context

As all changes proposed in the initial issue were reported as addressed, it's now our task to update the integration and make it dynamic (so whenever document-model-libs is updated, documentation is also updated automatically)

Tasks

  • Add document-model-libs as npm package
  • Update generateDocs script
  • Remove initial static md files
  • Manually test generation via docker-compose (as it might require additional changes to take md files from node_modules)
@valiafetisov
Copy link
Contributor Author

valiafetisov commented Jun 29, 2023

@KirillDogadin-std wrote:

not sure what the requirement remove initial static md files means in the issue. Could you elaborate what here is wrong if it is?

When writing the issue I thought that we kept initial md files provided to us and already executed generateDocs.ts somewhere during frontend build in order to produce content/documentation/index.md file. Now I see it's not the case, this particular point can be ignored.

What I would expect nevertheless, is that content/documentation/index.md file is produced automatically from the npm package and doesn't need an additional action from the developer (ie manually running generateDocs.ts and then committing generated file is not a desired flow)

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 a pull request may close this issue.

2 participants