Skip to content

Glues - Better way to doc glues without replication #111

@dalssoft

Description

@dalssoft

Currently it is hard to keep both herbsjs.github.io repo and glues repos in sync regarding doc.

Improving a glue implies in:
1 - Issue to the improvement X
2 - PR with the improvement X + doc X on readme.md
3 - Issue to doc X on herbsjs.github.io
4 - PR to doc X on herbsjs.github.io

Suggestion:
Have a way to read docs direct from glue repos and compose it on herbsjs.github.io repo to make step 3 e 4 unnecessary:

1 - Issue to the improvement X
2 - PR with the improvement X + doc X on ./doc folder
3 - rebuild herbsjs.github.io using docs from the glue

It would need a CI/CD magic (no idea how), but it would simplify a lot the current workflow.

Metadata

Metadata

Assignees

Type

No type

Projects

Status

More discussion is needed

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions