Comments (5)
Thanks for the feedback!
We have scheduled some initial work around getting better docs in place for this nodejs client library, so we should soon be able to publish some better docs.
I will update this thread when the first iteration is published.
from umbraco.headless.client.nodejs.
@flexchar This has now been addressed by #17 which was just merged. The README file is updated with details. For now you will need to generate the documentation from the repository, but we are working on getting it added to the Umbraco Heartcore documentation on https://our.umbraco.com/documentation/Umbraco-Heartcore/
from umbraco.headless.client.nodejs.
Hi @flexchar we do have a fair amount of documentation on our.umbraco.com/documentation/ but I do realize that its not actually linked to from anywhere in this repository. We will get that updated.
You can find API Documentation for all endpoints in both the Content Delivery and Content Management APIs here:
https://our.umbraco.com/documentation/Umbraco-Heartcore/API-Documentation/
But what you are asking for is usage documentation for the client library itself, right?
from umbraco.headless.client.nodejs.
I have seen these resources. However I don't find them particularly useful if I am onto using the official client. Which I believe should have at least method definitions for parameters.
Ideally examples on how to use particular method and what data to provide. Now it is merely a list of signatures on your client.
I will shamelessly share (I am not affiliated but happy customer) Sanity Client as an example. Sanity is another powerful headless CMS. https://www.npmjs.com/package/@sanity/client
If you would have docs like that, it would ease the process by a lot. :)
from umbraco.headless.client.nodejs.
If you have tests, please publish the code. That would on its own provide quite decent insight
from umbraco.headless.client.nodejs.
Related Issues (11)
- Any plan for support of rxjs observables? HOT 2
- Is this safe to use? HOT 2
- Support for varying URL configuration HOT 1
- Possible error with pageSize and page options, when using client.delivery.content.children HOT 2
- TypeError: Cannot read property 'data' of undefined HOT 1
- Support for TypeScript (typings) HOT 2
- Descendants call should be a PagedResponse in 0.8.0 HOT 1
- Axios dependancy IE11 issue HOT 1
- Do the client library work with angular? HOT 10
- Missing documentation on NodeJS Client? HOT 8
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from umbraco.headless.client.nodejs.