Permalink
Browse files

Minimal text to direct developers to either generated API documentati…

…on, Wiki or other important URLs.

Note: https://dotnet.github.io/docfx/tutorial/docfx.exe_user_manual.html section 3.2.2 Reserved Metadata for _appFooter and other important defaults one can override
  • Loading branch information...
christophwille committed Aug 18, 2017
1 parent 71164e5 commit afc8be62a019796983db7181c1d461f45dfd7abf
Showing with 18 additions and 7 deletions.
  1. +3 −2 docs/help/api/index.md
  2. +3 −1 docs/help/articles/intro.md
  3. +4 −0 docs/help/docfx.json
  4. +8 −4 docs/help/index.md
View
@@ -1,2 +1,3 @@
# PLACEHOLDER
TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!
# API Documentation
Please select class / method / property from the tree on the left side to learn more.
@@ -1 +1,3 @@
# Add your introductions here!
# Articles
FAQ and walk-through-sample explanations are provided in the [Wiki](https://github.com/icsharpcode/SharpZipLib/wiki)
View
@@ -60,6 +60,10 @@
]
}
],
"globalMetadata": {
"_appTitle": "SharpZipLib Help",
"_appFooter": "Copyright © 2000-2017 SharpZipLib Contributors"
},
"dest": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
View
@@ -1,4 +1,8 @@
# This is the **HOMEPAGE**.
Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
## Quick Start Notes:
1. Add images to the *images* folder if the file is referencing an image.
# Help Homepage.
Looking for the [API Documentation](api/index.md)?
Looking for the [source code](https://github.com/icsharpcode/SharpZipLib)?
Want to report a bug, suggest a new feature, ask a deep technical question? [Issues](https://github.com/icsharpcode/SharpZipLib/issues)

0 comments on commit afc8be6

Please sign in to comment.