Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS: Add clarificaitons and suggested changes to documentation #395

Merged
merged 5 commits into from
Aug 14, 2024
Merged

DOCS: Add clarificaitons and suggested changes to documentation #395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0da978a
Clarify acronyms in headline of README
scottstanie Aug 14, 2024
230afc9
clarify first section of license is BSD
scottstanie Aug 14, 2024
9a4e356
Add link to changelog on docs
scottstanie Aug 14, 2024
52fc49c
Fix broken tutorials and getting started links
scottstanie Aug 14, 2024
87ef5ed
Fix changelog link using snippets
scottstanie Aug 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ choose which license to apply. The terms of each license are reproduced below.

---------------------------------------------------------------------------------------

BSD-3-Clause License:

Copyright (c) 2022 California Institute of Technology ("Caltech"). U.S. Government
sponsorship acknowledged.

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
[github-discussions-link]: https://github.com/isce-framework/dolphin/discussions
<!-- prettier-ignore-end -->

High resolution wrapped phase estimation for InSAR using combined PS/DS processing.
High resolution wrapped phase estimation for Interferometric Synthetic Aperture Radar (InSAR) using combined persistent scatterer (PS) and distributed scatterer (DS) processing.

<!-- DeformatiOn Land surface Products in High resolution using INsar -->

Expand Down
1 change: 1 addition & 0 deletions docs/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--8<-- "CHANGELOG.md"
2 changes: 1 addition & 1 deletion docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
--8<-- "README.md:19:84"

For a more complete tutorial, see our [notebooks](notebooks)
For a more complete tutorial, see our [tutorials page](tutorials.md)

For help with installing locally and contributing, see the [full developer setup instructions](developer-setup.md).
1 change: 1 addition & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@
1. [Getting started](./getting-started.md)
1. [Tutorials](tutorials.md)
1. [Code Reference](reference/summary.md)
1. [Changelog](changelog.md)
<!-- 1. [How-To Guides](how-to-guides.md) -->
<!-- 1. [Background theory](background-theory.md) -->
4 changes: 2 additions & 2 deletions docs/notebooks/walkthrough-basic.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"\n",
"## Setup\n",
"\n",
"We first need to install `dolphin` as outlined in the [Getting Started](https://dolphin-insar.readthedocs.io/en/getting-started) section of the documentation. \n",
"We first need to install `dolphin` as outlined in the [Getting Started](https://dolphin-insar.readthedocs.io/en/latest/getting-started/) section of the documentation. \n",
"\n",
"If you are running this in Colab, you can install [`dolphin` using `pip`](https://pypi.org/project/dolphin/)\n"
]
Expand Down Expand Up @@ -569,7 +569,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.4"
"version": "3.11.6"
},
"vscode": {
"interpreter": {
Expand Down