Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Activity
  • 08:14
    luyinhua commented #1283
  • 05:00
    ocavue commented #1286
  • 04:43
    ocavue opened #1286
  • 03:48
    gengjiawen commented #1258
  • Oct 21 15:06
    baelter opened #1285
  • Oct 21 08:27
    HUANGWEIWEIWEI commented #1283
  • Oct 21 03:03
    luyinhua commented #1283
  • Oct 20 09:57
    davidsneighbour commented #1283
  • Oct 20 03:03
    xavieryao commented #1241
  • Oct 20 03:00
    devdocs-bot closed #1276
  • Oct 20 03:00
    devdocs-bot commented #1276
  • Oct 20 03:00
    devdocs-bot opened #1284
  • Oct 19 21:50
    RandellDawson commented #1283
  • Oct 19 21:47
    lommaj commented #1283
  • Oct 19 21:45
    lommaj commented #1283
  • Oct 19 21:44
    lommaj commented #1283
  • Oct 19 21:44
    lommaj commented #1283
  • Oct 19 21:43
    lommaj commented #1283
  • Oct 19 21:38
    RandellDawson commented #1283
  • Oct 19 20:57
    lommaj opened #1283
SepSol
@SepSol
can you please add support for MongoDB and GraphQL documentations as well?
Julien Naour
@jnaour_gitlab
Hi, I'm trying to use devdocs to expose my own documentation (mostly sphinx documentation). How can I use it to scrape local files? For the moment I create my own scraper (a FileScraper), it seems the there are some example like python numpy etc, but what I don't get is where the path to the local directory is define. I tried to use the "dir" attributes, but it doesnt work... Is there some simple example of devdocs usage to scrape local docs and expose it in the app ?
Julien Naour
@jnaour_gitlab
It seem that the doc is out of date, dir doesn't exists anymore. I'll try to use example like C or python
Sean Stringer
@stringa
All docs are put into the same location for processing.
Julien Naour
@jnaour_gitlab
Is there some scrapper/filter allready available for doxygen documentation ?
Julien Naour
@jnaour_gitlab
It doesn't seem so but you never know :D
Thanks for the great project anyway
Julien Naour
@jnaour_gitlab
Hello. In my input there is some code example. I want to keep the indentation so it's still readeble. clean_html filter seems to delete all the indentation. How can i keep it?
Right now I try to put a fix_code.rb filter just before clean_html like for c or cpp to handle the issue. But clean_html continue to delete the indentation. it's the content.gsub! %r{[[:space:]]+}, ' ' that is killing my day
Julien Naour
@jnaour_gitlab
At the end I use breathe and exhale projects to convert doxygen doc to sphinx and use the filter in devdocs.
Jonathan Arnett
@J3RN

Hello! I'm looking to see if anyone is actively maintaining DevDocs. I was going to add some documentation for ecto_sql, but noticed that several PRs to add documentation have been open for upwards of a month. The last merge was three months ago.

Not trying to be negative, I'm just curious about the project status 🙂

Jasper van Merle
@jmerle
I think it's fair to say the project is unmaintained at the moment
Anders Bälter
@baelter
That's very sad for such a great project. @Thibaut are you willing to take on some maintainers?
Sean Stringer
@stringa
Is there a way to take elements from other pages and push them to the root index?
Sean Stringer
@stringa
I'm still confused why I can't return nil for a type.
Starbeamrainbowlabs
@sbrl
Hey there! Does anyone know where I can request docs to be updated? PHP is out of date (devdocs has 7.2, but 7.4 is released; 7.3 changes setcookie() in particular), and Node.js is also out of date (devdocs has 12.x, but latest is 14.x; worker threads changed stability level in Node 14)
Thibaut Courouble
@Thibaut
@baelter I donated DevDocs to freeCodeCamp to help spur a community of maintainers. Unfortunately that hasn't happened to the extent we were hoping, but if you or anyone else is interested in working on DevDocs I'm sure Quincy & team can set you up :)
I'm at a stage of my life where I don't have the time/energy/will to maintain DevDocs as I used to, but am always happy to answer questions and do code reviews, especially if it helps new maintainers ramp up.
Starbeamrainbowlabs
@sbrl
Ah, I see. Thanks for the reply @Thibaut! I was just wondering if there was a way to request that a scraper to be kicked off again in whatever backend it is that powers devdocs.io is all - is there anyway to get in touch with Quincy (I assume they are responsible for this)?
Sadly I do not know Ruby / have a Ruby dev environment, otherwise I would have contributed a scraper or two before :P
Is there support for scrapers in other languages at all?
Joel Burton
@wjoelburton_twitter
Hi, all. I'm partially through writing a new scraper/filter for Flask, but have a stumbling block.
The only part of Flask's docs that are a good fit for DevDocs is their API page. I've got my scraper just reading that page and feeding it into my filter successfully.
However, it creates one high-level entry for everything; I'd like to break that up by classes.
If there's a pointer to a docset like this, I can dig into that.
Starbeamrainbowlabs
@sbrl
I think that Node.js might do something similar @wjoelburton_twitter
Joel Burton
@wjoelburton_twitter
Thanks, @sbrl, I'll take a look there.
Starbeamrainbowlabs
@sbrl
np
not a devdocs dev / contributor myself (don't know Ruby), but am happy to help :-)
Shadowplays4K
@Shadowplays4k
does the devdocs have an api where I can search for stuff?
Anders Bälter
@baelter
@QuincyLarson @Thibaut I'd be happy to help out, at least with keeping some languages up to date with new versions.
Starbeamrainbowlabs
@sbrl
Just a user here, but that would be awesome! I've been noticing that they've been getting out of date @baelter
Gergely Gombos
@gombosg

Hi all, yes, DevDocs is kind of dying at the moment... lots of issues, stale PRs, no commits since months.... I hope it can still be saved, because it's been my favorite docs browser for years and there's really no alternative to it.

@Thibaut , we understand that you don't have the time to maintain this project, but what is your vision for its future?
How would it be possible to onboard maintainers/contributors?
What I imagine as goals:

  • keep the builds running!
  • merging doc update PRs, reviewing, keeping code quality up
  • triaging issues
  • if possible, fixing some critical bugs

-> for all this, probably no extensive Ruby knowledge is needed. It would be enough to leave the project in a maintenance state.

As I see from the count of PRs, the community is here to help.

What would be the way to move forward?

Senya
@cmrd-senya
Hello! I've opened this little PR with a change for the Gemfile today: freeCodeCamp/devdocs#1271
Its main purpose to fix the issue that is blocking devdocs to be run as a systemd service.
Would be great if someone could take a look
Starbeamrainbowlabs
@sbrl
Might be worth sending an email, @gombosg. Maybe use the git commit history and cc in a bunch of recent contributors?
If that doesn't work, I'm afraid it might be time for a fork.
I don't know Ruby at all, but I'd be happy to help out with reviewing, triaging issues etc
Thibaut Courouble
@Thibaut

@sbrl @baelter @gombosg if you're able to rally a small team behind maintaining DevDocs over the long haul, feel free to email me at thibaut@me.com and I'll be happy to help set this up with Quincy + share context on an ongoing basis.

In the past whenever we've had a single active maintainer it has proven impossible to sustain over time and we end up burning that person out. I think for DevDocs to thrive we need a team, but to this day we haven't been able to find enough maintainers to form one.

Unlike most other open source projects, it's a big time commitment to maintain DevDocs and the work is quite repetitive. On the flip side, DevDocs is still very popular and helping out many thousands of developers. I'd love to see it thrive.

Jasper van Merle
@jmerle
I can confirm the time commitment and the repetitiveness of the work (I guess I was that single active maintainer once) and can definitely recommend getting at least 2 people together so you can divide the workload a bit (and to have someone to review your own PR's)
Starbeamrainbowlabs
@sbrl
Perhaps an advertisement for more maintainers in the README would help here, with a direction to this Gitter?
I'd perhaps say a team of 3-5 at least would be ideal
I don't have the xp with Ruby to assist with the code, which is my main concern
Thibaut Courouble
@Thibaut
I can merge PRs to the README if you or some else wants to organize the search for maintainers (just @mention me on the PR)
Jed Fox
@j-f1
I think the reason I burned out was a combination of not enough free time left after schoolwork and the backlog of PRs and updates that resulted in. I’d be happy to collaborate with other folks — maybe we could each pick a subset of the docs to maintain?
Jed Fox
@j-f1
It would also be great to figure out a way to automatically update the docs — @jmerle’s bot is a great start but it would be great if it could act on the updates and only open an issue if it detects a problem with the update. I could also add a link to report issues with the docs to each page so the burden of checking for errors resulting from changes in the sites we scrape rests a little more on the users (who know the docs they’re reading pretty well).
Senya
@cmrd-senya
IMO it really helps when you work as a team rather than maintaining a project alone. This way you can motivate each other and also you don't feel pressured because you know that someone else can help whenever you need a break. I think it can really help to avoid burn out if there are 3-4 people who share the maintenance work.
Michael Skorokhodov
@Samsuper_gitlab
Hello! When will the information about C ++ be updated? I mean C++ 20. Or should I start adding information myself?
Starbeamrainbowlabs
@sbrl
@Samsuper_gitlab Devdocs scrapes from websites. It's probable that the scraper hasn't been run in a while. See the conversation above for that.
Pavel
@yekm
docs from man pages section 2?
Starbeamrainbowlabs
@sbrl
@yekm As far as I know DevDocs doesn't scrape man pages. I don't know of another project that does that, but it must exist.
Pavel
@yekm
cant find it
Adding all of them to DevDocs would make the search unusable
it will be slow or it is just a matter of too many seemingly useless results in the seach results
?