Simplified README #261
Simplified README #261
Conversation
|
@yebai or @devmotion happy with this? |
README.md
Outdated
| @@ -1,484 +1,13 @@ | |||
| # Bijectors.jl | |||
|
|
|||
| [](https://turinglang.github.io/Bijectors.jl/stable) | |||
| [](https://turinglang.github.io/Bijectors.jl) | |||
There was a problem hiding this comment.
Maybe keep a link to the latest release (stable) and the latest (possibly unreleased) commit (dev)?
There was a problem hiding this comment.
Unfortunately stable docs doesn't exist 😕
There was a problem hiding this comment.
AFAICT the problem is that TagBot.yml contains a bug - the action does not have sufficient permissions to trigger other Github actions, and hence docs won't be built when a new tag/release is made.
There was a problem hiding this comment.
We should be able to fix this and then we could point to stable docs as well.
There was a problem hiding this comment.
Still not finding any stable docs 😕
There was a problem hiding this comment.
Was a new release created after the TagBot PR was merged? I think only then a stable docs build should be triggered.
There was a problem hiding this comment.
Aaah, gotcha. Aight, I'll add it to the README then.
Co-authored-by: David Widmann <[email protected]>
|
Done:) |
|
Good to go now @devmotion ? |
|
Thanks man! |
The current README is from a time before we had documentation for Bijectors.jl. Now that we do, I think we should just simplify the it, and defer everything to the documentation.