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.

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

Version does not appear in slate API docs #14

Open
pmartincalvo opened this issue Aug 29, 2022 · 3 comments
Open

Version does not appear in slate API docs #14

pmartincalvo opened this issue Aug 29, 2022 · 3 comments

Comments

@pmartincalvo
Copy link

Hi, not sure if this is the right place to post this. If it's not and you let me know what's the right one, I'll happily move it.

The docs currently shown in https://bisq-network.github.io/slate don't show the version they are describing anywhere. I think it's important that this page reflects the version being described as to not confuse readers.

@ghubstan
Copy link
Owner

Good place to post this... I try to keep the API Reference doc in sync with the bisq master branch. Not sure that's the best thing to do, and I need to discuss with other dev(s). FYI (again), the reference describes Bisq master.

@pmartincalvo
Copy link
Author

I am not completely familiar with Slate, but with ReadTheDocs it's relatively easy to keep several versions of the docs alive. For instance, one for each tag as well as one for master.

I think that would be ideal, but again, I'm not aware of Slate's capabilities, so just some wishful suggesting.

And thanks for confirming what the docs reference to.

@ghubstan
Copy link
Owner

I spent a little time trying to find out how slate might allow us to document several releases of the API, but nothing obvious showed itself. I'll have to come back to this problem after finishing a couple of other tasks.

In the mean time, I at least make it obvious the API reference documents the Bisq master branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants