stac-spec icon indicating copy to clipboard operation
stac-spec copied to clipboard

Extract Best Practices from spec

Open philvarner opened this issue 7 months ago • 4 comments

Currently, the Best Practices document is part of the released spec. Instead, this should be in an independent repo, so that it can be updated an evolved separately from the relatively-stable and infrequently-released spec. There are many other useful pieces of information and suggestions that can be added to this too, as well as "conversations" on more controversial design decisions, suggestions, etc.

philvarner avatar May 06 '25 13:05 philvarner

Hmm. I agree that the best practices could use some updates, but I'm not persuaded that this means they need to move from the spec repo. Lot's of libraries store their docs versioned alongside their code even when improvements to docs could apply to older versions. In particular in this case I think people are reading the best practices directly on github (is this true?), so they can easily choose the ~master~ dev branch to see the latest and greatest. This seems like more of an issue for built docs where the version might be more obfuscated.

jsignell avatar May 09 '25 14:05 jsignell

After writing that I realized that the master branch is the released version and is the default. I think if we just change that setting in github, so that dev is the default branch it'll maybe be clearer.

jsignell avatar May 09 '25 14:05 jsignell

PSC decision from July 2025 is to move the best practices to https://github.com/radiantearth/stac-best-practices

m-mohr avatar Aug 05 '25 09:08 m-mohr

The best practices doc (from branch dev) with its git history has now been moved to the new repo.

jsignell avatar Sep 18 '25 14:09 jsignell