Skip to content

Commit d509644

Browse files
committed
Fixes in documentation.
1 parent 94b8c6a commit d509644

File tree

3 files changed

+12
-21
lines changed

3 files changed

+12
-21
lines changed

docs/content/index.fsx

+10-19
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,12 @@
77
QuickGraph
88
======================
99
10-
Documentation
11-
1210
<div class="row">
1311
<div class="span1"></div>
1412
<div class="span6">
1513
<div class="well well-small" id="nuget">
16-
The QuickGraph library can be <a href="https://nuget.org/packages/QuickGraph">installed from NuGet</a>:
17-
<pre>PM> Install-Package QuickGraph</pre>
14+
The QuickGraph library can be <a href="https://nuget.org/packages/YC.QuickGraph">installed from NuGet</a>:
15+
<pre>PM> Install-Package YC.QuickGraph</pre>
1816
</div>
1917
</div>
2018
<div class="span1"></div>
@@ -37,15 +35,7 @@ Some more info
3735
Samples & documentation
3836
-----------------------
3937
40-
The library comes with comprehensible documentation.
41-
It can include tutorials automatically generated from `*.fsx` files in [the content folder][content].
42-
The API reference is automatically generated from Markdown comments in the library implementation.
43-
44-
* [Tutorial](tutorial.html) contains a further explanation of this sample library.
45-
46-
* [API Reference](reference/index.html) contains automatically generated documentation for all types, modules
47-
and functions in the library. This includes additional brief samples on using most of the
48-
functions.
38+
The library is fork of original QuickGraph project and migration is not finished. So, please use [original documentation][origQGDoc].
4939
5040
Contributing and copyright
5141
--------------------------
@@ -55,13 +45,14 @@ the project and submit pull requests. If you're adding a new public API, please
5545
consider adding [samples][content] that can be turned into a documentation. You might
5646
also want to read the [library design notes][readme] to understand how it works.
5747
58-
The library is available under Public Domain license, which allows modification and
48+
The library is available under Ms-PL license, which allows modification and
5949
redistribution for both commercial and non-commercial purposes. For more information see the
6050
[License file][license] in the GitHub repository.
6151
62-
[content]: https://github.com/fsprojects/QuickGraph/tree/master/docs/content
63-
[gh]: https://github.com/fsprojects/QuickGraph
64-
[issues]: https://github.com/fsprojects/QuickGraph/issues
65-
[readme]: https://github.com/fsprojects/QuickGraph/blob/master/README.md
66-
[license]: https://github.com/fsprojects/QuickGraph/blob/master/LICENSE.txt
52+
[content]: https://github.com/YaccConstructor/QuickGraph/tree/master/docs/content
53+
[gh]: https://github.com/YaccConstructor/QuickGraph
54+
[issues]: https://github.com/YaccConstructor/QuickGraph/issues
55+
[readme]: https://github.com/YaccConstructor/QuickGraph/blob/master/README.md
56+
[license]: https://github.com/YaccConstructor/QuickGraph/blob/master/LICENSE.txt
57+
[origQGDoc]: https://quickgraph.codeplex.com/documentation
6758
*)

docs/tools/generate.fsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ let info =
2121
"project-author", "Jonathan \"Peli\" de Halleux"
2222
"project-summary", "Graph datastructures and algorithms for .NET."
2323
"project-github", githubLink
24-
"project-nuget", "http://nuget.org/packages/QuickGraph" ]
24+
"project-nuget", "http://nuget.org/packages/YC.QuickGraph" ]
2525

2626
// --------------------------------------------------------------------------------------
2727
// For typical project, no changes are needed below

docs/tools/templates/template.cshtml

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<div class="container">
2424
<div class="masthead">
2525
<ul class="nav nav-pills pull-right">
26-
<li><a href="http://fsharp.org">fsharp.org</a></li>
26+
<!--li><a href="http://fsharp.org">fsharp.org</a></li-->
2727
<li><a href="@Properties["project-github"]">github page</a></li>
2828
</ul>
2929
<h3 class="muted"><a href="@Root/index.html">@Properties["project-name"]</a></h3>

0 commit comments

Comments
 (0)