Skip to content

Data-driven documentation-ing #3537

Closed
Closed

Description

@JJ

TL;DR: data-mine GitHub looking for usage of different Raku features.

There's moment now where there are thousands of Raku modules published, and lots of other repos that use Raku. Using GitHub search, we could look for them and then log their usage of specific syntactic features, classes, and class methods. With this information, there are several things that can be done

  • Try and match usage with documentation. If a specific thing is used widely, it should be well documented; all issues related to that specific feature solved and, in general, prioritized over other features.
  • Link from documentation to examples of using them "in the wild", or harvest it for examples.

I general, anyway, it's interesting to find out how many repositories are there, how they grow, and of course help them whenever possible.

Activity

  1. added
    docsDocumentation issue (primary issue type)
    on Jul 26, 2020
  2. Altai-man commented on Jul 26, 2020

    @Altai-man
    Member

    This sounds like a topic for a research paper, but not an action-able ticket, no?

  3. added
    wishlist"nice to have" issues; might require a lot of work or a big change or be low priority
    metaRFCs, general discussion, writing style, repository organization, etc.
    on Jul 26, 2020
  4. JJ commented on Jul 26, 2020

    @JJ
    ContributorAuthor

    Well, the second item is quite actionable, and can be done by just using the GitHub search engine. Doing systematically is something else, but I have always thought that working in the documentation only reactively is the wrong approach.

  5. JJ commented on Jul 26, 2020

    @JJ
    ContributorAuthor

    Also, don't see anything wrong in research stuff in a language that started basically as a research project in virtual machines...

  6. MasterDuke17 commented on Jul 26, 2020

    @MasterDuke17
    Contributor

    This sounds like it would make a nice GSoC proposal, especially once the RakuAST work is finished.

  7. JJ commented on Jul 27, 2020

    @JJ
    ContributorAuthor
  8. locked and limited conversation to collaborators on Nov 26, 2022
  9. converted this issue into a discussion #4141 on Nov 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation issue (primary issue type)metaRFCs, general discussion, writing style, repository organization, etc.wishlist"nice to have" issues; might require a lot of work or a big change or be low priority

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions