docs: API quick links [skip ci]

jg-rp · Sep 22, 2023 · 5e30621 · 5e30621
1 parent 4dd2a01
commit 5e30621
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/docs/docs/README_API.md b/docs/docs/README_API.md
@@ -1,3 +1,10 @@
 # JSON P3 API Documentation
 
-TODO:
+Welcome to the API documentation for JSON P3. Also see the [quick start guide](/quick-start) for an introduction to using JSON P3.
+
+## API Quick Links
+
+- [JSONPathEnvironment](/api/classes/jsonpath.JSONPathEnvironment)
+- [JSONPathEnvironment Options](/api/namespaces/jsonpath#jsonpathenvironmentoptions)
+- [JSONPathNodeList](/api/classes/jsonpath.JSONPathNodeList)
+- [JSONPathNode](/api/classes/jsonpath.JSONPathNode)
diff --git a/docs/docs/guides/json-patch.md b/docs/docs/guides/json-patch.md
@@ -1,6 +1,6 @@
 # JSON Patch
 
-[JSON Patch](./quick-start.md#json-patch) ([RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902)) is a standard for describing update operations to perform on JSON-like data. Each operation includes, at least, an `op` string and a `path`, which is a [JSON Pointer](./json-pointer.md).
+JSON Patch ([RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902)) is a standard for describing update operations to perform on JSON-like data. Each operation includes, at least, an `op` string and a `path`, which is a [JSON Pointer](./json-pointer.md).
 
 Use [`jsonpatch.apply(ops, data)`](../api/namespaces/jsonpatch.md#apply) to apply _ops_ to _data_, where _ops_ should be an array of [`OpObject`s](../api/namespaces/jsonpatch.md#opobject), as per RFC 6902. Patch operation are applied sequentially and, unless the target JSON document's root value is replaced, **data is modified in place**.