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.

Sign up for GitHub

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

Jump to bottom

Add Docfx example #3

Open
BernieWhite opened this issue Aug 25, 2017 · 2 comments
Open

Add Docfx example #3

BernieWhite opened this issue Aug 25, 2017 · 2 comments
Labels
documentation An issue or feature that affects documentation instead of code

Comments

@BernieWhite
Copy link
Member

Provide an example of using PSDocs with Docfx.
@BernieWhite BernieWhite changed the title Added Docfx example Add Docfx example Aug 25, 2017
@BernieWhite BernieWhite self-assigned this Aug 25, 2017
@BernieWhite BernieWhite added the documentation An issue or feature that affects documentation instead of code label Nov 24, 2017
@wonsil
Copy link

wonsil commented Aug 29, 2020

Hi Bernie,
I've been thinking about taking information about an ERP system and creating DocFx markdown to document a particular instance. PSDoc looks exactly what I want. What do you want in a DocFx example that I may help with?

@BernieWhite BernieWhite removed their assignment Sep 1, 2020
@BernieWhite
Copy link
Member Author

@wonsil Thanks for your interest in PSDocs.

Ideally a walk though similar to Azure template, but anything in between is great. It's more about the process so that someone can understand how to integrate and run with DocFX. For example you may have to build a toc.yml file.

When including any output examples be sure to sanitize so that it doesn't contain real system names.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation An issue or feature that affects documentation instead of code
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@wonsil @BernieWhite