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 needs updating #49

Open
james-martin-jd opened this issue Dec 4, 2019 · 3 comments
Open

Documentation needs updating #49

james-martin-jd opened this issue Dec 4, 2019 · 3 comments

Comments

@james-martin-jd
Copy link

Didn't see an issue for this yet, so though I'd open one to track it. The documentation and README is currently very out of date, and doesn't cover some basic use cases. Notably missing is .set, .add, and .delete, as well as .from.

I think the rest of the docs should also be reviewed for accuracy and much has changed since it was written. Some kind of small tutorial / example code would also be very nice.

@linonetwo
Copy link

So it can add files or folders now? Where can I learn how? From the test? The test is a bit abstract.

@Vinnl
Copy link

Vinnl commented Jan 2, 2020

@linonetwo I don't think LDFlex can specifically add empty files or folders yet, but examples of some common operations can be found here, in lieu of official documentation: https://vincenttunru.gitlab.io/tripledoc/docs/cheatsheet

@james-martin-jd
Copy link
Author

james-martin-jd commented Jan 3, 2020

@linonetwo to my knowledge, no, it can't add files/folders, but it can delete. I believe .add() creates a new literal or node, and .set adds OR updates a literal or node value. But this kind of confusion is exactly why I think additional documentation is needed, as the current readme is very out of date.

I typically just use a fetch to create a file or folder, according to the Solid Spec.

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

3 participants