sourcefuse / sourcefuse/loopback4-microservice-catalog
docs: setup gh workflow to push `/docs` to sourcefuse/arc-docs repo
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 297
- Forks
- 78
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 4
Description
Currently the docs content and API references markdown files are statically placed inside arc-api-docs.
It should be in-sync with the /docs directory. Which is currently not hydrated with API ref files to avoid the clutter.
So we need to find a way to not keep API refs in master branch (to avoid the clutter as it can be auto-generated anytime) but still push the complete docs having API refs using a gh-workflow.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the /docs directory and the existing arc-docs/docs/arc-api-docs layout linked in the issue. Determine how API reference files are generated and how a GitHub Actions workflow could publish the complete documentation to sourcefuse/arc-docs without retaining generated references in the master branch. Done means the workflow keeps the target documentation repository in sync, including API references.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, typescript
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100