Reorganize docs, add a 'Get Started' tutorial#947
Conversation
|
@PanierAvide This is looking really good! One thing is that I think CHANGES.md should not be a symlink. |
|
I can put it back in root folder, and restore symlink from docs to |
jonhealy1
left a comment
jonhealy1
left a comment
There was a problem hiding this comment.
@PanierAvide Looks really good, just a few thoughts. A few things also like spelling mistakes that existed before, but we might as well fix them now.
There was a problem hiding this comment.
@vincentsarago @hrodmn Gitter is no longer available. Should we leave it blank? I wasn't sure about the right link for the Slack group?
| 11. Publicize the release via the appropriate social channels. |
There was a problem hiding this comment.
@PanierAvide some of these spelling mistakes are clearly not your fault, but we might as well fix them now :)
| We recommend using [`uv`](https://docs.astral.sh/uv) as the project manager for development. |
There was a problem hiding this comment.
This instantiate_api method comes from not yet released changes: stac-utils/stac-fastapi-pgstac#381. I don't think there is a database_url option?
There was a problem hiding this comment.
| This repo is set to use `pre-commit` to run *ruff*, *pydocstring* and *mypy* when committing new code. |
|
|
||
| ## Personalize settings | ||
|
|
||
| You can make the API a bit more _yours_ by changing the description settings in `.env` file: |
There was a problem hiding this comment.
Let's add something about how this is highly recommended as well because clients like stac-browser use these fields to advertise
|
Github messed up some of my suggestions? I don't know how to fix them now, but they should all be pretty obvious. |
2 participants
Related Issue(s):
Description:
Proposal of documentation improvements:
docs/srcto avoid broken links on MkDocs, added symbolic links for redirectsREADME.mdto linking to MkDocs website (to avoid either broken links or 90% of copied text content)Feel free to make changes and reorganize at your will 😁
PR Checklist:
pre-commithooks pass locallymake test)make docs)