Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Activity
  • Oct 30 03:29
    stuartpb edited #1287
  • Oct 30 03:27
    stuartpb synchronize #1287
  • Oct 30 03:26
    stuartpb opened #1287
  • Oct 23 13:22
    j-f1 synchronize #1172
  • Oct 23 13:21

    j-f1 on master

    Searching for maintainers Update README.md Merge pull request #1285 from b… (compare)

  • Oct 23 13:21
    j-f1 closed #1285
  • Oct 23 12:22
    baelter synchronize #1285
  • Oct 22 08:14
    luyinhua commented #1283
  • Oct 22 05:00
    ocavue commented #1286
  • Oct 22 04:43
    ocavue opened #1286
  • Oct 22 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
Simon Legner
@simon04_gitlab
@SKalt, I'm not aware of an official guideline or discussion in the past. Some projects (such as webpack or Moment.js) only provide the documentation for the latest release. Thus, DevDocs cannot provide earlier versions. Otherwise, I've got the impression that it's a subjective decision whether to keep older versions.
Do you have a concrete example which needs discussion?
Jasper van Merle
@jmerle
Here's how I approached it in the past: if updating a doc that already has multiple versions, simply add the latest version as a new version and don't worry about the existing versions. If creating a doc, only add the latest version unless there is a good reason to include multiple versions (e.g. when an older version of the library/language is still widely used).
Steven Kalt
@SKalt
Thanks! I was interested in archiving the older docs of go, git, and sqlite, but I don't have evidence that any prior version of those is widely used. I get the impression that devdocs is a reference rather than an archive, so I'd agree that "only add the latest version unless there is a good reason to include multiple versions" is probably the right policy.
Enmei Tu
@hellotem
PyTorch is one of the two most popular deep learning libraries (the other is TensorFlow, which has been included in DevDocs). It will be much helpful to include API and tutorial documentation in DevDocs.
Enmei Tu
@hellotem
@simon04_gitlab Thanks for your information. I will check that.
Lo, Chiwei
@pegasusroe
Hello, I'm new to DevDocs. Can we import Apple API docs into DevDocs?
Jed Fox
@j-f1
Unfortunately not because they’re not licensed for commercial reuse.
(Or ant reuse at all as far as I can tell)
Winni Kretzschmar
@winni2k
Hi, I have been using devdocs with great joy for a while now. I work in bioinformatics and I'd like to try and contribute some documentation for some commonly used tools (in my field). An example of a very popular tool is samtools. However, I'm not sure it would make sense to have a bunch of bioinformatics-specific documentation lumped in at the main level of the app. Is there a way to contribute documentation as part of a separate "bioinformatics" package? Should I just go ahead and contribute the samtools docs even though it only has ~900 stars on github? Would such documentation be accepted into the main devdocs app?
Hélio
@insign
Hi, laravel doc is so outdated, where can I inform that? issues?
Simon Legner
@simon04_gitlab
Hi @insign, a PR is open since 2019-12-20, see freeCodeCamp/devdocs#1148
Daniels L.
@dannobytes
image.png
hey everyone, here up in northern CA bay area, and noticed the site is not loading for me and few other colleagues:
finding that this particular file from this CDN is corrupt and cut off:
https://cdn.devdocs.io/assets/docs-31f573a73f53c4e931a61650946ab11c420c979f4c1f8f33deafad9bdf0899c7.js
scroll to the bottom. anybody else having this issue?
Karmel Salah
@karmelyoei
???
Hello
I am just wondering if there is an API for freecodeacadmy so we can use it to get info for users like courses and point accomplished any one has an idea ?
Simon Legner
@simon04_gitlab
@dannobytes, yes, see freeCodeCamp/devdocs#1213 for another report.
Jasper van Merle
@jmerle
I've seen that issue before, posted a possible solution to the GitHub issue
Simon Legner
@simon04_gitlab
Hi all, I wonder what the future of DevDocs will be. For me, having up-to-date documentation is the key asset of DevDocs. If DevDocs is lacking decently new versions of software, people will stop using DevDocs eventually. The number of outdated documentation has been increasing. On 2020-01-01 I offered my help in maintaining DevDocs; I was invited to the GitHub project and have been gardening the GitHub issues; I wasn't supposed to merge/publish documentation updates. At the moment, we have 18 outstanding PRs, some being open for months, nearly all of them being documentation updates.
Jasper van Merle
@jmerle
Wait for real? Except for Thibaut and possibly myself (not sure) you added and/or updated more docs than anyone else, so it seems weird not to let you continue doing that from a maintainer's position after you have already been trusted with access to the GitHub project.
@j-f1 I know I'm not a maintainer anymore and that there may be some backstory that I am missing, but given his previous contributions (see https://github.com/freeCodeCamp/devdocs/pulls?q=is%3Apr+author%3Asimon04+sort%3Aupdated-desc+is%3Aclosed) I'd really recommend giving Simon rights to merge and publish new and updated documentations.
Jed Fox
@j-f1
I agree. Not sure why he doesn’t have permissions. I think freeCodeCamp ppl are the only ones who can remedy that.
Jasper van Merle
@jmerle
@raisedadead can you help here?
Mrugesh Mohapatra
@raisedadead

Hi Guys.

I just checked that Simon is in the GitHub devdocs team, which should give them write access on the repo. As for the access to other places like the CDN, Heroku, AWS, etc, we can do that too howsoever way you would prefer, there is no reason for Simon to not have access. :)

We simply do not add maintainers to all places to avoid giving access accidentally. Just being safe than sorry. I think this will be simpler if Simon & Jed can hop on a quick 15 min call with me, I could do this real quick.

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
@samfundev
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
@samfundev
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
@samfundev
@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
@samfundev
@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
@samfundev

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
@samfundev
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
@samfundev
@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.
Sam
@samfundev
@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
@samfundev
@stringa I also already have a CleanHtmlFilter but you didn't address my question.