This repository contains the Intent Architect documentation hosted at https://docs.intentarchitect.com/docs. See the Contributing Guide below and the issues list if you would like to help out.
Articles in the repository are stored as Markdown files. Simple changes to the content of a Markdown file are made in the browser by selecting the Edit link in the upper-right corner of the browser window. (In a narrow browser window, expand the options bar to see the Edit link.) Follow the directions to create a pull request (PR). We will review the pull request and accept it or suggest changes.
To make more complex submissions, contact the Intent team at [email protected] outlining what you want to do. We will respond with steps on how you can make your submission.
This article outlines the way that content needs to be supplied before any Pull Requests are accepted.
This folder contains the source markdown for Intent Architect's documentation. DocFX is then run against the docfx.json file and along with the .md files, our documentation is generated into the _site folder (which is .gitignore'd). The contents of the _site folder are then uploaded to the website at http://intentarchitect.com/docs/ by the Intent Architect team.
Visual Studio Code has some good extensions to aid in writing documentation:
From the command line run:
_tools/DocFX/docfx.exe docfx.json --serveOr alternatively:
./_build_and_serve.ps1From the command line run:
_tools/DocFX/docfx.exe docfx.jsonIf there is a strange build error, try completely deleting the obj folder. This folder only contains build artifacts, the worst that can happen from its deletion is that the next build may take a little longer.