Convert docs site to Jaspr · flame-engine/flame

(12 comments) (4 reactions) (0 assignees)Dart (1,021 forks)batch import

enhancementhacktoberfest

Repository metrics

Stars: (10,575 stars)
PR merge metrics: (Avg merge 3d 22h) (6 merged PRs in 30d)

Description

Problem to solve

It would be great to have our docs site in Jaspr to have even more of our code-base in Dart (and avoid weird package update problems from other ecosystems etc).

Jaspr is a free and open source framework for building websites in Dart. Create fast and dynamic web experiences with ease in a familiar language and ecosystem.

Proposal

We would need the following from Jaspr:

Docs written in markdown
Flutter examples embedded on the page
Mermaid diagram rendering
Syntax highlighting for code

According to @schultek 1, 2 and 4 already exists and 3 should be possible to create.

More information

Currently we are using Sphinx
The root of our docs live here: https://github.com/flame-engine/flame/tree/main/doc
The docs are built and published from this repository: https://github.com/flame-engine/flame-docs-site/

Other

Are you interested in working on a PR for this?

Contributor guide

Research direction: Explore the Jaspr framework's capabilities for rendering markdown, embedding Flutter widgets, syntax highlighting, and Mermaid diagrams. Familiarize yourself with the current documentation setup using Sphinx and the repository at flame docs site. Identify the steps needed to replicate the existing functionality in Jaspr.
Tech stack: dartflutter
Domain: documentationfrontend
Issue type: Refactor
Difficulty: 3
Estimated time: 3-5 days
Activity status: Active
Clarity: Mostly clear
Prerequisites: DartGit
Newbie friendliness: 65