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

Documentation #57

Open
urso opened this issue May 22, 2024 · 2 comments
Open

Documentation #57

urso opened this issue May 22, 2024 · 2 comments

Comments

@urso
Copy link
Collaborator

urso commented May 22, 2024

The readme is getting quite big and it is becoming difficult for users to find the right information or we didn't yet document things properly. To improve the DX and especially getting started experience I would like to split the readme out into a proper documentation.

TODO: sections/structure?

@aleclarson
Copy link

I see the docs folder. Is that accessible anywhere?

@urso
Copy link
Collaborator Author

urso commented Nov 18, 2024

Yes, the docs are published via github pages: https://xataio.github.io/pgzx/#test.pgzx

Looks like something changed in docs building last time I checked. Everything is now reported under the test namespace. But these are generated docs only. These need some more work as well, but I'm thinking to provide some more how-to like docs.

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