Skip to content

Version 2.0 Roadmap #2983

Description

@JJ

Since markdown can't be used in a milestone description, I'm moving it here

After Google Summer of code, there are a couple of projects related to documentation: @antoniogamiz's Perl6::Documentable and @noisegul 's next-generation p6doc. They have made a great work, but we need to to put them to good use.
This milestone will gather all tasks related to introducing them as perl core documentation tools. Roughly, this is the roadmap:

  • Adopt these modules as part of the Raku organization, so that anyone can work on them (done: Documentable, rakudoc)

  • Test them thoroughly so that they reproduce as much as possible the current behavior. These first two need not be in the same order.

  • Publish Documentable in the ecosystem.

  • Start using Documentable to generate documentation

  • Create a Documentable container for CI and independent generation

  • Create a deployment script that depends on it.

  • Delete all functionality from the repository that has been superseded by documentable.

  • Modify utilities that depend on Pod parsing, such as Pod::To::OneBigPage

  • Spin off web generation tools.

  • Incorporate Documentable into Travis test

  • Make the rest of the tools depend on Documentable, tests and so on.

  • Move Documentable up the tool chain so that it gets used by Pod::To::OneBigPage and Pod::To::HTML. Or at least make them aware of the existence of the cache.

  • Move all web assets and tools to a different repository.

  • Move all Raku/doc tools to a different repository.

Eventually, the objective is to have 4 different repositories where there's now just one:

  1. Raku/doc will contain just the documentation and tests related to it.

  2. Raku/Documentable will contain the documentable script and modules.

  3. Raku/doc-web will contain the assets and business logic to generate the static web pages and deploy it to the web.

  4. Raku/rakudoc will contain the command-line interface to the documentation.

There are no actual modules that depend on the documentation, so we don't really foresee any breaking changes; however, since it's included in Rakudo Star, some bumpy road is expected. Please use this milestone to create issues that are related to this specific change.

Metadata

Metadata

Assignees

Labels

metaRFCs, general discussion, writing style, repository organization, etc.

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions