-
Notifications
You must be signed in to change notification settings - Fork 292
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 it's listed here; Please also join to the monthly status call (Second Saturday every month at noon Eastern time at https://meet.jit.si; room: raku-docs) to discuss ongoing efforts or to get involved!
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.
Any issues currently considered blockers for ongoing work
An effort is underway to replace the existing docs site with new tooling that will allow us to improve the UI, work with the Raku DevOps team to allow for more continuous updates and address many of the issues in this repo tagged with a label of "site".
See https://github.com/Raku/doc-website which contains the tooling needed to build the new site.
Many items raised in this RSC meeting
The issues list and this wiki itself contain many requests, wishlist items, potential improvements, and bugs. Need to map these out into specific action plans, some of which can be resolved by PRs already in progress, some which will require discussion, and some which require a simple matter of programming to resolve.
#raku-doc - Logs
There are a limited number of folks working on Raku/doc and related issues, and it's important that we communicate as a team. While IRC and github are our main contact points, we've had a sporadic call to stay in touch and coordinate on planning for the roadmap.
be some sort of (probably) monthly "call". Contact info for the call will be posted here, and please reach out on #raku-doc on IRC.
Last call: December 10, noon Eastern time. Next call: TBD.
Squashathons - we used to be able to get folks together regularly to hack on raku/rakudo/doc issues, but this seems to have stopped. We should probably remove references to this from our meta docs: #4066
(Actual) Documentation
Any tickets tagged "Docs" should be for updates or new documentation. We should consider a separate tag for tickets that impact the documentation but are not about a particular feature, e.g. marking which version a feature is part of, and yet again about editorial concerns about styleguide changes, etc.
Recommendation of ordering:
- Existing submitted documentation PRs, e.g. #4047
- Anything simple so we can close the ticket
- Checklists for release information in reverse order (newest first)
- Oldest tickets first
Documentation in related projects: Should also consider efforts around:
- nqp opcode documentation
- moarvm architectural documentation
There are several issues related to the docs.raku.org site; These include some major project items (above), but also potential changes to styles, presentation, bugs in certain browsers, etc. These will all move to doc-website if still applicable after the new site.
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
- Cut a documentation release? #2690 - at a minimum, we want to be able to publish docs again.