FreeCodeCamp/DevDocs

Jasper van Merle

@jmerle

Totally understandable, thanks for replying, I'll leave this up to you, Jed and Simon now :)

Jed Fox

@j-f1

I’ve DMed a when2meet

Gad1001

@Gad1001

Hi is there a way to get all of the text file in a txt file?

*files

Sam

@samfun123

Hey, I wanted to try to add new documentation so I tried to setup the app locally but I ran into the same issue as the person in freeCodeCamp/devdocs#1152. Any ideas on how I could fix the issue?

Sam

@samfun123

Sorry, just to clarify I'm only experiencing the error mentioned in the first post where it doesn't download any of the default documentation. The server does run though.

Sean Stringer

@stringa

I believe if you run via docker, you will get all the documentation. If you load the server from source, you may need to call thor to download all the docs.

Sam

@samfun123

@stringa I did call thor to download the documentation but I got this in the console:

(1/6) DOM Events FAILED (Errno::ENOENT: No such file or directory - gunzip)
(2/6) HTTP FAILED (Errno::ENOENT: No such file or directory - gunzip)
(3/6) HTML FAILED (Errno::ENOENT: No such file or directory - gunzip)
(4/6) JavaScript FAILED (Errno::ENOENT: No such file or directory - gunzip)
(5/6) CSS FAILED (Errno::ENOENT: No such file or directory - gunzip)
(6/6) DOM FAILED (Errno::ENOENT: No such file or directory - gunzip)

Jasper van Merle

@jmerle

Sounds like you're missing a gunzip binary, could you try downloading Gzip for Windows (http://gnuwin32.sourceforge.net/packages/gzip.htm) and adding its bin directory to your PATH? Gzip for Windows appears to come with a gunzip binary

Sam

@samfun123

@jmerle I installed that and I'm still getting the same error. It seems like Gzip includes a gzip.exe but it doesn't include a gunzip.exe, just a gunzip which I thought only worked for bash. I'm using the command prompt not bash.

Jasper van Merle

@jmerle

Oh thats unfortunate

gunzip seems to be just gzip -d, maybe https://stackoverflow.com/a/51905574 can help?

Sam

@samfun123

Getting closer but there's still something wrong as I'm getting this now:

[unix_utils] `gunzip --stdout C:/Users/Sam/AppData/Local/Temp/open-uri20200428-1500-rs6ocn` STDERR:

gzip: stdin: unexpected end of file
(1/6) DOM Events OK
[unix_utils] `gunzip --stdout C:/Users/Sam/AppData/Local/Temp/open-uri20200428-1500-t8wllb` STDERR:

gzip: stdin: unexpected end of file
(2/6) HTTP OK
... etc ...

I tried adding IO.write("#{doc.path}.tar.gz", file.read) after it downloaded the file so I could look at what it downloaded but I can't open any of them with 7-Zip or gunzip. I also tried manually downloading one with curl and the file was fine.

Sam

@samfun123

Ignore that last bit about not being able to open them, I had to do something else to get Ruby to write out the file as binary. Everything else still applies.

Jasper van Merle

@jmerle

Hmm, weird, no idea what's going wrong here

Sam

@samfun123

@jmerle Well I appreciate the help. It's not really important that I get those working anyways.

I have a separate question about adding documentation. I really wanted to get .NET documentation added so that's what I'm working on. I wanted to hide the field, property and method pages and just show the class page on the sidebar categorized by what namespace they're in. I saw this mentioned in the filter documentation: Entries without a type can be searched for but won't be listed in the app's sidebar. Which seemed like exactly what I want but I tried returning nil from get_type but that causes an error. What should I be returning so can do this?

Sean Stringer

@stringa

you will need a custom filter I believe.

https://github.com/freeCodeCamp/devdocs/blob/master/docs/filter-reference.md

Sam

@samfun123

@stringa Could you explain what you mean exactly? I already have a custom EntriesFilter for the documentation.

Sean Stringer

@stringa

@samfun123 Look around at all the existing filters for references to the Ruby code needed to delete css. It's pretty simple, like css('.error-undescribed').remove . Here is one example https://github.com/freeCodeCamp/devdocs/blob/master/lib/docs/filters/rust/clean_html.rb

@samfun123 Entries is mostly for indexing, and clean_html is for deleting whole sections. I typically rip the .css from the documentation tool and add that to the assets.

Sam

@samfun123

@stringa I also already have a CleanHtmlFilter but you didn't address my question.

Sean Stringer

@stringa

@samfun123 I believe that nil thing doesn't work. I think I am either ignoring pages, or sorting them into a category.

Sam

@samfun123

Well that's a shame as I feel like it would make this documentation a bit cleaner but I guess it could always be added later if it's really necessary. If it is actually not something implemented in devdocs then that should be removed from the filter reference so that people don't get confused.

Sebastian Dyroff

@sebastian-dyroff

Hey is there any work done on including the aws-cdk docs?

Wallen Han

@WallenHan

anyone knows why setup the local verion devdocs some resource told 403 forbidden

Wallen Han

@WallenHan

oh not the project problem,i use nginx reverse proxy the site , i should set the header for cross-region

fixxed it

Evandro Ribeiro

@ribeiroevandro

Hi!
Is there anyone including Styled Components?

SepSol

@SepSol

Hi, thanks for your awesome web app!

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?

Jul	AUG	Sep
	06
2019	2020	2021

Where communities thrive

People

Repo info

Activity