Change Details

Hackathon project: a tool to collate and render tools' documentation from docs-in-code source (e.g. Markdown for Sphinx or mkDocs) — a '[[https://readthedocs.org/ |Read the Docs]]' for Toolforge. Background info: https://meta.wikimedia.org/wiki/Community_Tech/Documentation * Repo: https://gitlab.wikimedia.org/repos/commtech/toolforge-docs * Website: https://docs.toolforge.org/ Basic features: * Overview on the homepage of all available documentation, including all tools with `user_docs_url` defined. * Cronjob to periodically look for tool repos with `docs/` directories, to build their docs. * Support for multiple languages and versions, e.g. `https://docs.toolforge.org/<tool>/<ver>/<lang>/` where `ver` can be a number, `stable`, or `latest`. //More details t.b.a.//

Hackathon project: a tool to collate and render tools' documentation from docs-in-code source (e.g. Markdown for Sphinx or mkDocs) — a '[[https://readthedocs.org/ |Read the Docs]]' for Toolforge. Background info: https://meta.wikimedia.org/wiki/Community_Tech/Documentation * Repo: https://gitlab.wikimedia.org/repos/commtech/toolforge-docs * Website: https://docs.toolforge.org/ Basic features: * Overview on the homepage of all available documentation, including all tools with `user_docs_url` defined (this latter part is somewhat done). * Cronjob to periodically look for tool repos with `docs/` directories, to build their docs. * Support for multiple languages and versions, e.g. `https://docs.toolforge.org/<tool>/<ver>/<lang>/` where `ver` can be a number, `stable`, or `latest`. * Support different docs generators. Sphinx and mkDocs are most likely. * Full-text search of the generated HTML. This could also extend to indexing the existing docs pages (~600 exist). * Possibly the design of the site can match what's developed for T273840 (or vice-versa). //More details t.b.a. — please add any ideas here!//

Hackathon project: a tool to collate and render tools' documentation from docs-in-code source (e.g. Markdown for Sphinx or mkDocs) — a '[[https://readthedocs.org/ |Read the Docs]]' for Toolforge. Background info: https://meta.wikimedia.org/wiki/Community_Tech/Documentation * Repo: https://gitlab.wikimedia.org/repos/commtech/toolforge-docs * Website: https://docs.toolforge.org/ Basic features: * Overview on the homepage of all available documentation, including all tools with `user_docs_url` defined (this latter part is somewhat done). * Cronjob to periodically look for tool repos with `docs/` directories, to build their docs. * Support for multiple languages and versions, e.g. `https://docs.toolforge.org/<tool>/<ver>/<lang>/` where `ver` can be a number, `stable`, or `latest`. * Support different docs generators. Sphinx and mkDocs are most likely. * Full-text search of the generated HTML. This could also extend to indexing the existing docs pages (~600 exist). * Possibly the design of the site can match what's developed for T273840 (or vice-versa). //More details t.b.a. — please add any ideas here!//