7 ms·
> DocC creates a Vue.js web app This is the main problem with web that people are raising. Something as simple as documentation, that obviously should be a col
by kklisura 5y ago
> DocC creates a Vue.js web app
This is the main problem with web that people are raising.
Something as simple as documentation, that obviously should be a collection of static pages, is now a web application.
You don't need React, Vue, Angular, Ember, etc. What you're building now might not be web application.
- KptMarchewa 5y agoWait, what? What do they need it for?
- Andrew_nenakhov 5y agoTo a boy with a hammer everything looks like a nail, I guess.
- planb 5y agoInteractive Tutorials? https://developer.apple.com/documentation/docc/building-an-interactive-tutorial https://developer.apple.com/documentation/docc/building-an-i... I found that via web search, but I couldn't find a demo anywhere online...
- pornel 5y agoThe tutorials are written manually in a SwiftUI-like script. It's a totally different thing from the docs auto-generator.
- planb 5y agoThanks for clarifying, but are you sure? On the very page I mentioned, there's a link at the bottom: "Distributing Documentation to External Developers" and on that page it says: "Share your documentation directly with Xcode users or host it on a web server." Sounds to me like you build that documentation using the SwiftUI-like DSL, but it is distributed in the DocC package.
- deleted 5y ago[deleted]
- coldtea 5y agoSearch? Interaction? Collapsable sections? It's 2021.
- Klonoar 5y agoNone of these require a framework.
- coldtea 5y agoWe don't use frameworks because they're required, we use them because they make dev lives easier and provide some common ready-made structure and functionality. Strictly speaking, nothing ever requires a framework: after all, any framework is just code - and you could always write vanilla code to achieve the same functionality (up to re-implementing the whole code of the framework yourself from scratch).
- Klonoar 5y agoThis comment does nothing except state the obvious. ;P The parent I'm responding to listed very simple examples that in no way necessitate a framework; of course frameworks can be useful for larger scaffolding and the like. Where exactly do you think you're commenting...?
- Zababa 5y agoRust has all of them with vanilla JS. The code is clear and easy to understand, and could be reused by other people easily. Here's an example: https://doc.rust-lang.org/std/vec/struct.Vec.html https://doc.rust-lang.org/std/vec/struct.Vec.html
- ironmagma 5y agoThere is no way anyone in their right mind would call main.js[1] easy to understand. It's basically complete chaos. Guillaume is making a good effort to clean up this inherited code slowly, but the interactions are still kind of broken and will be until this code is rewritten in a sane pattern such as MVU. FWIW, I have been working towards this for the past year. [1] https://github.com/rust-lang/rust/blob/master/src/librustdoc/html/static/main.js https://github.com/rust-lang/rust/blob/master/src/librustdoc...
- pjmlp 5y agoActually this has existed since forever, back in 2000 that would either be a Java Applet or DHTML.
- misterS 5y agoThe Windows 95 ".chm" help pages [1] were basically HTML pages, displayed in an application embedding Internet Explorer. IIRC this lead to login exploits (since the login screen was able to show help pages). [1] https://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help https://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help
- GeekyBear 5y agoMicrosoft Compiled HTML Help (.chm) has been the bane of all that is good and true ever since 1997.
- ChrisRR 5y agoThat doesn't make it better. We should be realising the mistakes of our past and improving with time
- LeoNatan25 5y agoFrom my experience, web developers don’t recognize their mistakes, they dig deeper and deeper holes for themselves.
- pram 5y agoBefore that we would have had lovingly troffed manuals, checklists, man pages, binders, and libraries of books sitting in our spacious cubicle. Embrace tradition imo!
- sligor 5y agoMaybe I'm wrong, but vue.js is just frontend js. So in theory it can be used in pair with a static server on backend side. So the problem here is surely not vue.js
- deleted 5y ago[deleted]
- noctune 5y agoIMO, search is a pretty significant part of docs and I haven't seen a good way doing that without either javascript or a web server. But other than that, yeah, you don't really need JS.
- est31 5y agoRust's documentation uses javascript for search but it uses no js framework at all. IIRC the normal experience works without any JS. In fact it doesn't even use any traditional js tooling, allowing people to contribute to rustdoc without having to install npm.
- GrayShade 5y ago> allowing people to contribute to rustdoc without having to install npm In the meanwhile, the crates.io team doubled down on Ember to attract front-end developers while presumably alienating a lot of other potential contributors.
- jitl 5y agoRecall that cargo and crates was built by one of the Ember founders, Yehuda Catz.
- GrayShade 5y agoWere they? I don't see wycats among the crates.io contributors on GitHub. He did contribute a bit to cargo in 2015, though.
- Zababa 5y agoThe crates.io website is weird, it seems out of place and not at the same level as the other part of Rust's ecosystem.
- gumby 5y agoYou can just pass the query to an external search engine , adding a `site:xxx` restriction.
- nine_k 5y agoA web app (as in SPA) can very well be a bunch of static files. I once wrote one at work, served off S3. Client machines are powerful enough now to do a lot, e.g. to scan a full-text search index packaged as a static file.