Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
    Gerhard Preuss
    @lipp
    if people like it, i'd be happy to add this
    thanks!
    :smile:
    Cinezaster
    @Cinezaster
    Do you do a git pull?
    Gerhard Preuss
    @lipp
    I do git fetch, git checkout etc when webhook events arive
    (so i am not polling each repo)
    do you think doclets.io is going to be useful?
    Cinezaster
    @Cinezaster
    of course. But then I wouldn't be so difficult to fetch from an outside git server.
    I think this could be very useful
    We are always struggling to keep our code documented.
    Gerhard Preuss
    @lipp
    i picked github to try out if the project gets some users/"fans" as i think most repos are hosted on github today.
    Cinezaster
    @Cinezaster
    Indeed, very wise decision.
    Gerhard Preuss
    @lipp
    would you like to use it for "internal" docs? (meaning they wouldn't be accessible for the public)
    Cinezaster
    @Cinezaster
    yes
    Gerhard Preuss
    @lipp
    may i cite "We are always struggling to keep our code documented." on the landing page? it's just exactly what i wanted to say but cannot quote myself :)
    Cinezaster
    @Cinezaster
    You can
    Gerhard Preuss
    @lipp
    how would you like to manage "visibility". using bitbuckets organizations?
    THX!
    Cinezaster
    @Cinezaster
    something like that.
    or we could run our own hosted version of doclets . It is based on docker anyway.
    Gerhard Preuss
    @lipp
    ah ok, that also a good option
    Cinezaster
    @Cinezaster
    That way we could add our ssh key of that server to stash
    Gerhard Preuss
    @lipp
    do you prefer "self hosting"?
    true
    Cinezaster
    @Cinezaster
    I do not prefer self hosted. I just see it as an option for having our inhouse documentation private
    Gerhard Preuss
    @lipp
    ok. great to hear your thoughts!
    Cinezaster
    @Cinezaster
    Self hosted also means maintaining, updating, ...
    Gerhard Preuss
    @lipp
    exactly
    i think that's the beauty of all these web services
    Cinezaster
    @Cinezaster
    indeed
    I'll keep an eye on this. If I can help with something let me know.
    Gerhard Preuss
    @lipp
    do you have other features you liked to see or "pain" doing the docs yourself?
    thanks a lot!
    Eugen Istoc
    @genu
    Hi. Does dockets support angular flavor of jsDoc?
    Gerhard Preuss
    @lipp
    no yet
    Jan Aagaard Meier
    @janmeier
    Hi there
    I've been testing out using doclets for the api docs for sequelize.js - And so far its looking good :)!
    I was wondering whether it is possible to get an idea of how the docs will look locally so I don't have to commit and wait for it to be regenerated each time?
    Gerhard Preuss
    @lipp
    hi jan!
    happy you like doclets! sorry, this is not possible yet. but i'll add a tool to npm for local testing. the workflow will be something like:
    $ npm install doclets -g 
    $ cd your-project
    $ doclets preview 8090
    Gerhard Preuss
    @lipp
    actually i started developing this but suspended it for now. i'll create an "enhancement" issue
    Jan Aagaard Meier
    @janmeier
    Cool, sounds good :)
    How is the documentation generated? Does it use the default jsdoc cli, or another parser?
    Gerhard Preuss
    @lipp
    it is using the jsdoc cli package with a custom plugin which outputs the parsed data as JSON. Then from the raw JSON data the html is generated
    Jan Aagaard Meier
    @janmeier
    Ah okay :)
    I might try my luck with the jsdoc cli for now then, since most of the errors now are functions ending up in the wrong namespace (actually no namespace at all)
    Gerhard Preuss
    @lipp
    yes, this should work for you. the naming hierarchy is the same as outputed by jsdoc cli. but if not defined, namespaces are auto guessed. A symbol named foo.bar will be nested into an implicitly defined namespace "foo" if it is not existent. But I really recommend to do it explicitly as jsdoc would like to have it.
    Gerhard Preuss
    @lipp
    @genu what exactly do you mean with angular jsdoc flavor? could you provide me some link?