Skip to content

Commit

Permalink
Minimal text to direct developers to either generated API documentati…
Browse files Browse the repository at this point in the history
…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 afc8be6
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 7 deletions.
5 changes: 3 additions & 2 deletions docs/help/api/index.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 3 additions & 1 deletion docs/help/articles/intro.md
Original file line number Diff line number Diff line change
@@ -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)
4 changes: 4 additions & 0 deletions docs/help/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@
]
}
],
"globalMetadata": {
"_appTitle": "SharpZipLib Help",
"_appFooter": "Copyright © 2000-2017 SharpZipLib Contributors"
},
"dest": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
Expand Down
12 changes: 8 additions & 4 deletions docs/help/index.md
Original file line number Diff line number Diff line change
@@ -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.