dotnet / dotnet/docfx

[Docs] [Enhancement Request] Add some more information details to the config of exclude

Open
#10,743 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

**Is your feature request related to a problem? Please describe.**

Reading through the docs of docfx > Config page, I am missing information about why we might consider excluding the includes path. Dont get me wrong, I did see it on multiple docfx created repos already, where this folder did include `[!INCLUDE ` files.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

would be nice, if there would be some informations about how this is related to the used markdown and what would be the result when not excluding those. same seen for the `_site/**` and `obj/**` ( in overwrite part of the docfx.json build, but I would not know why we should do this.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

Keep guessing and fiddling for hours or days currently to finally get the docfx setup to the desired result of output.

**Additional context**
Add any other context or screenshots about the feature request here.

page of the docs:
https://dotnet.github.io/docfx/docs/config.html first topic

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.