Home

Welcome to the raku/doc wiki!

This page shows the roadmap related to Raku documentation, both for volunteers (see Community below) and interested parties.

If you are working on something for Raku documentation, please be sure there's an open ticket on one of the repositories; Please also join the monthly status call (Second Saturday every month at noon Eastern TZ at https://meet.jit.si; room: raku-docs) to discuss ongoing efforts or to get involved! some calls skipped due to collab of irc/github working as intended!

Next calls:

• TBD

Repositories

Documentation work for the Raku community is split over several repositories:

• doc - This repo. The docs for the Raku language, including some information about specific compilers content authors
• doc-website - For building and deploying the HTML website for raku/doc. web, module developers, content authors
• rakudoc - A command line reader for raku documentation - can be used with this repository or installed modules module developers
• nqp - Compiler tooling - documentation exists on architecture and opcodes available for compiler writings core developers, documenters
• moarvm - primary VM backend for nqp - documentation on VM architecture core developers
• Raku Steering Council meeting - these need to be converted to actionable items or discussions in doc repositories.

We have defined several milestones on various projects (linked above) - doc & doc-website both have milestones schedule by quarter, showing the priority of tickets in the short term. Anything that doesn't have a milestone is part of the backlog, and may need some grooming. If you want to volunteer for a ticket but are unsure how to proceed, please join IRC and ask.

Milestone	Desc	raku/doc	raku/doc-website	nqp
*	All doc tickets	issues	issues	issues
2023-43	due by 2023-12-31	issues	issues
backlog	lowest priority	issues

Needed

Any authors or editors greatly appreciated. Stop by #raku-doc on IRC to chat; If you can't, an email on perl6-users will eventually find us, or submit a PR to start a conversation, or start a github discussion, etc.

You don't have to understand raku when you start; the community can help you with questions about how things work. Look at "good first issue" tickets in issue trackers (mainly in raku/doc)

Community

IRC - raku-doc

• webchat
• logs

Ongoing Work

After every Rakudo compiler release, we should

• Create a ticket from the ChangeLog with a checklist for each documentation-worthy change
• Update the required Rakudo version to run the test suite in xt/01-raku-version.t

Roles

In no particular order:

• Product Owner
• Front End (web)
• Authors
• Editors
• QA - web
• QA - code
• POD6/Documentation Tooling
• Users ( primarily via the web)
• DevOps