Integrated docs gitHub community organisation

About Monkey 2 Forums Monkey 2 Development Integrated docs gitHub community organisation

This topic contains 39 replies, has 10 voices, and was last updated by  arpie 5 months, 1 week ago.

Viewing 10 posts - 31 through 40 (of 40 total)
  • Author
    Posts
  • #11575

    abakobo
    Participant

    For those who want a white themed docs: http://turdus.be/monkey2docs/whitedocs/

    The official docs are now white themed.

    #11634

    abakobo
    Participant

    Added a link in the online docs to the white doc page…

    #12375

    Vilmate
    Participant

    Very useful. Thanks!

    #13911

    abakobo
    Participant

    Could anybody check the english (and mx2) correctness of the following modification in docs before requesting a pull?

    thx

    https://github.com/blitz-research/monkey2/compare/develop...abakobo:wipdocs

    #13918

    arawkins
    Participant

    Hey Abakobo, I read over the commit and made a few small changes. You can see them here

    Sorry about the weird line break changes, I’m not sure what caused that.

    Also, I had a question about this line in modules/monkey/language/newdocs/pointers.md:

    Note that casting to Void Ptr is essentially used when dealing with external native code.

    I don’t understand Void Ptr enough to understand this line, but using “essentially” in that way doesn’t seem right. Do you mean it is the only use for Void Ptr, or just a common use?

    If it’s a common use, but not the only use, you might say:

    Note that casting to Void Ptr is commonly used when dealing with external native code.

    If dealing with external code is the only use for Void Ptr, you might want to be more specific:

    Casting to Void Ptr is used when dealing with external code.

    In the latter case, it might make more sense to move that up the doc towards a bit more, as it seems like an important piece of information to leave down at the end in a note.

    #13928

    abakobo
    Participant

    thanks arawkins!

    #14252

    arpie
    Participant

    @abakobo Hello!  Just found this thread.  I can’t believe I’d missed/forgotten about it!

    I’m wondering how the docs get from the m2docsCommunity repo onto the turdus.be website?  I presume that requires some sort of manual operation by you to upload it?

    BTW are you one of the turdus band members?

    #14256

    arpie
    Participant

    According to the github page, on the wipdocs branch :

    This branch is 27 commits ahead, 7 commits behind blitz-research:develop.

    Those 27 commits are the ‘dev up’ merges and shouldn’t really show up here.  I don’t understand why github doesn’t understand that they have been remerged back into blitz-research:develop.

    Anyway, I have rebased the wipdocs branch onto the latest blitz-research:develop (on my machine), and published the result to a new branch on m2docsCommunity repo called ‘rebased’.  It currently says :

    This branch is even with blitz-research:develop

    I think that if we now use this ‘rebased’ branch for pushing all doc updates, I will then be able to rebase it again before sending Mark a pull request.  As I’ve said before though rebasing is dangerous as it rewrites history and we should only do it once in a while, probably just before mark releases each new version.  One other advantage of us rebasing before Mark pulls is that if there are any conflicts, we can fix them before sending the pull request instead of dumping them on Mark!

    #14310

    abakobo
    Participant

    ok nice!
    sorry was a bit off mx2 last days…
    But great! Welcome to the docs community!

    Do you plan to write specific things (so we don’t work on the same ones..)?

    #14313

    arpie
    Participant

    Like you, I will have flurries of activity punctuated by periods of absence, depending on how my day job is going – I’m self-employed so my timetable tends to be erratic.  It would seem sensible to assign yourself an issue on github if you start writing on a particular topic.  That way we have a record of who is doing what.  I will probably try to tackle the issues I have reported on github before anything else.  And perhaps class functions.  But I leave for an 8 day holiday tomorrow so won’t be doing anything for a little while!

Viewing 10 posts - 31 through 40 (of 40 total)

You must be logged in to reply to this topic.