Comments (9)
So my preference would be:
- Use seStructuredText (or alternatively Markdown) as markup language.
- Put documentation into the Wakaama repository.
Eventually/later:
- Generate documentation page with Sphinx
- Publish documentation page on GitHub pages
- Document the code (public API) with Doxygen (industry standard) and also publish it on GithubPages
from wakaama.
I resume my opinion from #729 discussion.
- I strongly advice to put documentation in code repository,
- I strongly advice to use Markup language supported by Github,
- No urgency to use tooling to generate static web site, Github rendering is largely enough in first time. (better to focus on code and documentation content)
This is just advises, so up to active committers to decide 🙂 .
from wakaama.
@LukasWoodtli what you call GitHub page
is Github Wiki
?
(Not directly linked bu there is already very few page in Wakaama wiki. )
from wakaama.
@LukasWoodtli what you call
GitHub page
isGithub Wiki
? (Not directly linked bu there is already very few page in Wakaama wiki. )
No GitHub has web server functionality for project pages: About GitHub Pages
This is a convenient way to provide information about a project hosted on GitHub.
from wakaama.
I resume my opinion from #729 discussion.
1. I strongly advice to put documentation in code repository, 2. I strongly advice to use Markup language supported by Github, 3. No urgency to use tooling to generate static web site, Github rendering is largely enough in first time. (better to focus on code and documentation content)
This is just advises, so up to active committers to decide 🙂 .
👍
Agree!
from wakaama.
I didn't follow all details, but for "publish it on GithubPages" I would first ask the Eclipse Foundation.
It may be considered to be related to marketing or SEO and then I guess, using the Eclipse way (e.g. Californium Web-Pages wold be preferred by the Eclipse Foundation. Anyway, I don't know it, so asking the foundation, if that hasn't been already done, would be the best.
from wakaama.
Not sure to get the benefits to use GithubPages instead of publishing on Wakaama website.
But if you really want to go that way later, I also recommend to ask to eclipse foundation if this is OK. (just to be sure)
About Wakaama website :
- the website : https://eclipse.dev/wakaama/
- the repo of the website : https://github.com/eclipse/wakaama-website
from wakaama.
I had the impression, that the Eclipse Wakaama website is more static and includes general information where the GitHub page would be updated by each merge to the master branch with the newest developer documentation.
But maybe we can just publish everything on the Eclipse page.
I would discuss this as soon as we have any documentation to publish.
from wakaama.
Conclusion:
- Use reStructuredText as markup language.
- Put documentation into the Wakaama repository.
Eventually/later:
- Generate documentation page with Sphinx.
- Publish documentation page on the Eclipse page.
- Document the code (public API) with Doxygen and also publish it on the Eclipse page
from wakaama.
Related Issues (20)
- Documentation on how to use the library HOT 2
- SonarCloud and CodeQL jobs failed HOT 1
- Question: Why failed registration update goes into STATE_BOOTSTRAP_REQUIRED immediately? HOT 1
- [ANSWER] Which LWM2M version Wakaama Client supports? HOT 24
- Block-wise transfer on observe response? HOT 1
- server write operation , response COAP_400_BAD_REQUEST HOT 2
- Moving from Master to Main HOT 4
- Election of new committer HOT 9
- Option to transfer the Wakaama repository to its own organisation HOT 8
- How to use the wakaama library for Espressif HOT 5
- Question regarding the appropriate license for this project HOT 1
- Support of send operation for single resource data with TLV format ? HOT 10
- Is Leshan ready for production usage ? HOT 2
- Inquiry about CoAP Fetch Functionality Implementation HOT 3
- Client SEND operation does not use fragmentation leading to oversized CoAP packets
- Fixed buffer size in senml_json_serialize limits handling of multiple resources HOT 1
- Build Fails if LWM2M_RAW_BLOCK1_REQUESTS set HOT 4
- Compile server&client example with DTLS HOT 1
- Include other libraries in examples 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 wakaama.