Skip to content

Commit 2dabda0

Browse files
authored
Update docs (#385)
* move from uber.github.io/h3 to h3geo.org * add pydeck * fix pydeck link
1 parent 2fd690a commit 2dabda0

File tree

4 files changed

+7
-6
lines changed

4 files changed

+7
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99

1010
H3 is a geospatial indexing system using a hexagonal grid that can be (approximately) subdivided into finer and finer hexagonal grids, combining the benefits of a hexagonal grid with [S2](https://code.google.com/archive/p/s2-geometry-library/)'s hierarchical subdivisions.
1111

12-
Documentation is available at [https://uber.github.io/h3/](https://uber.github.io/h3/). Developer documentation in Markdown format is available under the [dev-docs](./dev-docs/) directory.
12+
Documentation is available at [https://h3geo.org/](https://h3geo.org/). Developer documentation in Markdown format is available under the [dev-docs](./dev-docs/) directory.
1313

1414
* Post **bug reports or feature requests** to the [GitHub Issues page](https://github.com/uber/h3/issues)
1515
* Ask **questions** by posting to the [H3 tag on StackOverflow](https://stackoverflow.com/questions/tagged/h3)
1616
* There is also an [H3 Slack workspace](https://join.slack.com/t/h3-core/shared_invite/zt-g6u5r1hf-W_~uVJmfeiWtMQuBGc1NNg)
1717

1818
## Installing
1919

20-
We recommend using prebuilt bindings if they are available for your programming language. Bindings for [Go](https://github.com/uber/h3-go), [Java](https://github.com/uber/h3-java), [JavaScript](https://github.com/uber/h3-js), [Python](https://github.com/uber/h3-py), and [others](https://uber.github.io/h3/#/documentation/community/bindings) are available.
20+
We recommend using prebuilt bindings if they are available for your programming language. Bindings for [Go](https://github.com/uber/h3-go), [Java](https://github.com/uber/h3-java), [JavaScript](https://github.com/uber/h3-js), [Python](https://github.com/uber/h3-py), and [others](https://h3geo.org/docs/community/bindings) are available.
2121

2222
On macOS, you can install H3 using `brew`:
2323
```

dev-docs/creating_bindings.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

33
H3 is a C library, in part to make it simpler to create bindings for different programming languages. Each language usually has its own way to bind to C functions, but this document can serve as a starting point and list of tips.
44

5-
There may already be [H3 bindings](https://uber.github.io/h3/#/documentation/community/bindings) available for your language of choice.
5+
There may already be [H3 bindings](https://h3geo.org/docs/community/bindings) available for your language of choice.
66

77
## Function naming
88

99
The `make binding-functions` target produces a file `binding-functions` containing a list of function in the H3 public API, one per line. You can use this as part of your build process to check how much of the H3 public API your bindings expose. This list does not include memory management functions that are needed to allocate arrays to be passed to the H3 API.
1010

11-
Keeping similar names and purposes for functions can make it easier for your users to use the H3 [API Reference](https://uber.github.io/h3/#/documentation/api-reference/).
11+
Keeping similar names and purposes for functions can make it easier for your users to use the H3 [API Reference](https://h3geo.org/docs/api/indexing).
1212

1313
## Community
1414

1515
When ready, make a [pull request](https://github.com/uber/h3/edit/master/docs/community/bindings.md) to add your binding to the H3 documentation website.
1616

1717
## Documentation
1818

19-
To be included in the H3 [API reference](https://uber.github.io/h3/#/documentation/api-reference/), your binding should:
19+
To be included in the H3 [API reference](https://h3geo.org/docs/api/indexing), your binding should:
2020

2121
* Be reasonably up to date with uber/h3.
2222
* Include bindings for the relevant functions in the output of `make binding-functions`. For example, `stringToH3` may not be necessary if your bindings only supports string H3 indexes.

docs/community/applications.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ The following applications use H3. Contributions to this list are welcome, pleas
55
## Visualization
66

77
- [kepler.gl](http://kepler.gl/) - An open source geospatial analysis tool
8+
- [pydeck](https://pydeck.gl/) - High-scale spatial rendering in Python, powered by deck.gl

website/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# H3 Documentation Website
22

3-
This is the source for the [H3 documentation website](https://uber.github.io/h3/).
3+
This is the source for the [H3 documentation website](https://h3geo.org/).
44

55
The source of the pages in the documentation is in the [docs](../docs) directory.
66

0 commit comments

Comments
 (0)