MapsterMapper / MapsterMapper/Mapster

[Docs][CI] Ensure docfx links stay valid, prepare future xml API docs options, keep docs simple maintainable and introduce CI integration for this

Open
#846 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs improvement
Dominant language
C#
Stars
5.2k
Forks
410
Avg merge
2d 12h
Merged PRs (30d)
6

Description

This Docs/CI Enhancement targets to keep `pre` / development Branch Docs + Releases API:
- cleanly seperated on their branch (intellisense/markdown suggestion support)
- allow valid API docs and source code linking in docs

> [!IMPORTANT]
> docfx docs generation will fail completly or produce invalid Links if we include the metadata step on a branch that doesn't include the to be linked file or src code!

To Ensure the latest docs PR *(find linked in Additional Information Section)* will not fall on our toes in the future or cause unnessesary additional (automate-able) work for us, we should consider:

- [ ] **GH Action for PR's md docs changes:** If there are only md docs changes (our current build not includes API docs) This should get triggered and add a PR for maybe cherry picking those commits from development onto master? but this will potentially be causing invalid links as soon as we step on to use API docs!

- [ ] **Enhance/Ensure proper Commit Labels:** We should then explicitly keep our commits cleanly seperated and scoped/categorized properly, which would include such relevant changes. It's possible for the commitlint.yml from what I readed by now, to add more allowed labels or similar but we should have this discussed and decided properly, what we want and maybe find ways to do this, which I maybe did possibly not consider here.

- [ ] **GH Action: Ensure DocFx correct build for API metadata:** Pay Attention as soon as we might want to use generate xml docs from any source code via metadata!
**Produce and add API Docs after changes on non-master-merge PR branches:**
- create the API them in this case after their source branch got a relevant PR merge
- have all docfx docs produced and merged to master (?) or @andrerav what do you think of reusing the `gh-pages` branch for our docs product then 🤔 ? possibly this is the cleanest way...

- [ ] **Review & Add DocFx `Content` Setup for API version support:**

I havn't been successfull by now with the `output` / `dest` settings in `docfx.json` which are linted as `depreciated` but I see many others still use them and I think this is required to have a proper xml API output control for this 🤔

- [ ] Possibly I will need to ask the docfx team for help, to come to a working setup, but my targeted idea would be something like this in our github.io web docs then:

image

## Additional Information

- #845
@DocSvartz @stagep @andrerav

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing docfx.json, commitlint.yml, the existing GitHub Actions workflows, and the related issue #845. The issue contains several possible CI, branch, labeling, and API-documentation approaches without a settled scope. Done would require an agreed design and working validation that generated documentation links remain valid.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, github-actions
Domain
build-system, ci-cd, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.