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 #36

Open
rofr opened this issue Dec 2, 2017 · 2 comments
Open

Documentation #36

rofr opened this issue Dec 2, 2017 · 2 comments

Comments

@rofr
Copy link
Member

rofr commented Dec 2, 2017

Port origodb docs, modify accordingly. Use GH flavored markdown in the docs sub folder.

@rofr rofr added this to the Memstate 1.0 Beta milestone Dec 2, 2017
@Inux
Copy link

Inux commented May 31, 2020

I noticed that the website is referencing memstate 1.0 beta but the actual release is 0.7.0.
It was a bit confusing to me and I needed to check the code to get things working. I think it would make sense to invest a bit in documentation to help newcomers to ramp up faster. Can I help somehow to improve it? Is the documentation automatically deployed from this repository?

@rofr
Copy link
Member Author

rofr commented Jun 2, 2020

Hi @Inux, yes the docs are not in a good place. Memstate is a rewrite/port of OrigoDB still in progress. I copied the docs from OrigoDB but much of it is outdated, obsolete or not yet completed. Publishing to memstate.io is not automatic, but we could set that up when it makes sense. The idea was that the docs would be in sync with the repo and copied to a subdirectory for each release version. @goblinfactory said this was premature optimization and he was right :)

Any help is welcome, feel free to join us on https://gitter.im/memstate/lobby and we'll take it from there.

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