Comments (3)
It is a good idea to have the same documentation but for our example.
I would move this in https://github.com/HTTP-APIs/hydra-ecosystem-wiki and leave this repository for automatically generated documentation from docstrings in the code.
You can create a PR on https://github.com/HTTP-APIs/hydra-ecosystem-wiki to add a Example.md
.
from documentation-hydrus.
@Mec-iS I think we already have good documentation of step 2,3 and 4.
I think beginners are feeling overwhelmed by HYDRA and JSON-LD specification and skipping or skimming it.
And we do not have step 1 implemented yet so I suggest until it's implemented we can have something similar to https://www.hydra-cg.com/spec/latest/core/#using-hydra . Here Marcus is using his issue tracker to illustrate how to write HYDRA API Documentation with JSON-LD. We can have somewhat same document but using drone-flock's documentation as an example (reference). As everything is based on HYDRA it will give beginners a great start and there will be less trivial questions related to Hydra in the chat room.
But at last, it will be the same thing Marcus is illustrating so it will involve huge duplication of his work.
If you think it's a good idea I can start working on it.
@chrizandr @xadahiya views or suggestions?
from documentation-hydrus.
Moved to HTTP-APIs/hydra-ecosystem-wiki#16
from documentation-hydrus.
Related Issues (10)
- Create autodoc building and deploying for hydrus
- Update documentation to latest merge on master HOT 1
- Move documentation to hydrus HOT 2
- Update documentation with respect to the changes done in hydrus HOT 2
- Improve README HOT 2
- module not found error HOT 7
- Get into the code and write a report about URSA HOT 1
- Research possibility of parsing from JSON schema HOT 1
- Publish the Wiki repository content alongside with hydrus documentation HOT 1
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 documentation-hydrus.