Skip to content

Commit 39879ed

Browse files
Copilotpetesramek
andauthored
fix: version switcher URL bug, improve index.md, remove Introduction from guide TOC
Agent-Logs-Url: https://github.com/petesramek/polyline-algorithm-csharp/sessions/8d569a33-0865-48a6-a617-c9dc86fedfe2 Co-authored-by: petesramek <2333452+petesramek@users.noreply.github.com>
1 parent 764e8f9 commit 39879ed

4 files changed

Lines changed: 29 additions & 18 deletions

File tree

.github/workflows/publish-documentation.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ jobs:
139139
{
140140
echo "### YamlMime:TableOfContent"
141141
echo "- name: Guide"
142-
echo " href: ${latest}/guide/introduction.html"
142+
echo " href: ${latest}/guide/getting-started.html"
143143
echo "- name: API Reference"
144144
echo " href: ${latest}/PolylineAlgorithm.html"
145145
} > api-reference/toc.yml
@@ -159,7 +159,7 @@ jobs:
159159
else
160160
label="v${ver}"
161161
fi
162-
echo "| ${label} | [Guide](${ver}/guide/introduction.html) | [API Reference](${ver}/PolylineAlgorithm.html) |"
162+
echo "| ${label} | [Guide](${ver}/guide/getting-started.html) | [API Reference](${ver}/PolylineAlgorithm.html) |"
163163
done
164164
} > /tmp/versions_section.md
165165
awk '/{versions_section}/{while((getline line < "/tmp/versions_section.md") > 0) print line; close("/tmp/versions_section.md"); next} {print}' \

api-reference/docs-versioning/public/version-switcher.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
function getSiteRoot() {
1515
var meta = document.querySelector('meta[name="docfx:rel"]');
16-
return meta ? meta.getAttribute('content') : './';
16+
return meta ? (meta.getAttribute('content') || './') : './';
1717
}
1818

1919
var VERSION_PATTERN = /\/\d+(\.\d+)*\//;
@@ -83,7 +83,7 @@
8383
);
8484
} else {
8585
var siteRootPath = new URL(getSiteRoot(), window.location.href).pathname.replace(/\/$/, '');
86-
newPathname = siteRootPath + '/' + targetVersion + '/PolylineAlgorithm.html';
86+
newPathname = siteRootPath + '/' + targetVersion + '/guide/getting-started.html';
8787
}
8888

8989
window.location.pathname = newPathname;

api-reference/guide/toc.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
- name: Introduction
2-
href: introduction.md
3-
- name: Getting Started
1+
- name: Getting Started
42
href: getting-started.md
53
- name: Configuration
64
href: configuration.md

api-reference/index.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,33 @@
1-
# PolylineAlgorithm API Reference
1+
# PolylineAlgorithm for .NET
22

3-
Welcome! This documentation provides guides, configuration options, examples, and FAQs for the PolylineAlgorithm library.
4-
For detailed class and method docs, see the versioned [API Reference]({version}/PolylineAlgorithm.html).
3+
Welcome to **PolylineAlgorithm for .NET**, a modern library for Google-compliant polyline encoding and decoding with strong input validation, extensible API design, and robust performance.
54

6-
## Contents
5+
## What is PolylineAlgorithm?
76

8-
- [Introduction]({version}/guide/introduction.html)
9-
- [Getting Started]({version}/guide/getting-started.html)
10-
- [Configuration Options]({version}/guide/configuration.html)
11-
- [Advanced Scenarios]({version}/guide/advanced-scenarios.html)
12-
- [Samples]({version}/guide/sample.html)
13-
- [FAQ]({version}/guide/faq.html)
7+
PolylineAlgorithm provides tools for encoding a sequence of geographic coordinates into a compact string format used by Google Maps and other mapping platforms, and for decoding those strings back into coordinates. Its simple API and thorough documentation make it suitable for .NET Core, .NET 5+, and any framework supporting `netstandard2.1`.
8+
9+
## Key Benefits
10+
11+
- **Standards compliance**: Implements Google's Encoded Polyline Algorithm as specified
12+
- **Immutable, strongly-typed objects**: Guarantees reliability and thread safety
13+
- **Extensible**: Custom coordinate/polyline support via abstract base classes and interfaces
14+
- **Robust input validation**: Throws descriptive exceptions for out-of-range or malformed input
15+
- **Configuration and logging**: Advanced options and integration with `ILoggerFactory`
16+
- **Benchmarked and tested**: Includes unit and performance tests
17+
18+
## Getting Started
19+
20+
Install via the .NET CLI:
21+
22+
```shell
23+
dotnet add package PolylineAlgorithm
24+
```
25+
26+
Then explore the versioned guide and API reference below to learn more.
1427

1528
{versions_section}
1629

1730
## Links
1831

19-
- [API Reference]({version}/PolylineAlgorithm.html)
2032
- [Contributing Guidelines](https://github.com/petesramek/polyline-algorithm-csharp/blob/main/CONTRIBUTING.md)
33+
- [Report an Issue](https://github.com/petesramek/polyline-algorithm-csharp/issues)

0 commit comments

Comments
 (0)