Stackflow Docs v2

[ho991217]

---

Landing Page

Title

• Stackflow
• The Flexible Stack Navigation UI Library

Shows demo

Features

• Headless Architecture: Use stack and transition states without pre-built UI, allowing full customization.
• Plugin-Driven Extensibility: Inject custom functionality via plugin interfaces at any lifecycle stage.
• Framework Agnostic: Seamlessly integrate with diverse frontend frameworks due to its decoupled core logic.
• Cross-Platform Rendering: Inject custom render logic to build both mobile web views and desktop apps from a single codebase.
• TypeScript & Server-Side Rendering support ensures scalability and performance.

Some icons or info graphics might be useful.

---

Docs Page

Introduction

• What is Stackflow?
• Design and principles
• Architecture
• Decision Log

Optional. is good to have

Getting Started

Installation

• Installation and Configuration
• Setting up basic UI

Activity

• Activity
• Registering a Activity
• Adding initial Activity
• Registering required parameters

Exploring

• Stacking new Activity
• Replacing current Activity
• Popping top Activity

Step

• Stacking Step
• Replacing Step
• Popping top Step

Advanced Usage

State

• Getting states
• Use Stack states for render
• Use Activity states for render

Customization

• Customize UI

Make Your Own Plugin

• Writing preset
• Basic interface
• Add render method
• Wrapping Stack
• Wrapping Activity
• Injecting action on init
• Effect hooks
• Determining initial Activity

---

API Reference Page

Future API

Configuration

Configuration in Activity

Activity

Fields in Activity

Plugin

compat-await-push

link

plugin-basic-ui

plugin-devtools

plugin-google-analytics-4

plugin-history-sync

plugin-map-initial-activity

plugin-preload

plugin-renderer-basic

plugin-renderer-web

plugin-stack-depth-change

react-ui-core

---

Extras

• Supports Korean and English
• New logo
• Bump nextra version to v3 (perhaps to v4)
• Add OpenGraph image

Stackflow documentation v2

[tonyfromundefined]

Thanks for the suggestion! I approve everything

[XiNiHa]

Hey, as the one working on #473, if you're considering merging it upstream 😂 could you also have adding Solid docs in mind? I'll definitely write the actual docs but I'd appreciate it if the structure of the docs is prepared for it 😋

[ho991217]

Hello, @XiNiHa. If you plan to contribute to the SolidJS documentation, the timing of your contribution can influence the approach we take. If it's before mid-October, it would be better to merge it into the current version of the document. However, if the contribution is expected after mid-October, we might need to consider adding a separate section for SolidJS.

[XiNiHa]

Personally, I'd want to merge the Solid integration (along with the docs? or docs as a follow-up? not sure 🤷‍♂️) after the V2 release of the core to minimize the efforts required while preparing for the V2 release. However, if the team expects my PR to be merged before V2, I'm also open to that 😅

[ho991217]

I'd appreciate it if you would merge after we launch docs v2 :)