Skip to content

Commit afc8be6

Browse files
Minimal text to direct developers to either generated API documentation, 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
1 parent 71164e5 commit afc8be6

4 files changed

Lines changed: 18 additions & 7 deletions

File tree

docs/help/api/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1-
# PLACEHOLDER
2-
TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!
1+
# API Documentation
2+
3+
Please select class / method / property from the tree on the left side to learn more.

docs/help/articles/intro.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
# Add your introductions here!
1+
# Articles
2+
3+
FAQ and walk-through-sample explanations are provided in the [Wiki](https://github.com/icsharpcode/SharpZipLib/wiki)

docs/help/docfx.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,10 @@
6060
]
6161
}
6262
],
63+
"globalMetadata": {
64+
"_appTitle": "SharpZipLib Help",
65+
"_appFooter": "Copyright © 2000-2017 SharpZipLib Contributors"
66+
},
6367
"dest": "_site",
6468
"globalMetadataFiles": [],
6569
"fileMetadataFiles": [],

docs/help/index.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# This is the **HOMEPAGE**.
2-
Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
3-
## Quick Start Notes:
4-
1. Add images to the *images* folder if the file is referencing an image.
1+
# Help Homepage.
2+
3+
Looking for the [API Documentation](api/index.md)?
4+
5+
Looking for the [source code](https://github.com/icsharpcode/SharpZipLib)?
6+
7+
Want to report a bug, suggest a new feature, ask a deep technical question? [Issues](https://github.com/icsharpcode/SharpZipLib/issues)
8+

0 commit comments

Comments
 (0)