Skip to content

Docs structure: separate user and developer paths with shared core #86

Description

@kirkone

Summary

The current documentation and website structure mixes two very different audiences: photographers who want to get a portfolio live quickly, and developers/theme authors who want to customize and extend Revela.

We should make the docs clearer by introducing two explicit entry paths while keeping shared core content in one place.

Why this matters

  • The current docs feel more like a technical reference than a guided product experience.
  • The website sample already shows that there are two real user types behind the product.
  • A clearer structure would make the product easier to understand for first-time users and easier to extend for developers.

Proposed direction

  1. Keep a shared core of documentation for:
    • installation
    • configuration
    • deployment
    • CLI reference
    • general concepts
  2. Add two explicit entry paths:
    • For photographers / end users
    • For developers / theme authors / plugin authors
  3. Make cross-cutting topics (for example theme customization) available in two perspectives:
    • simple path for users
    • advanced path for developers
  4. Use explicit, audience-aware wording and helpful cross-links instead of forcing users to infer their role.

Expected benefits

  • Better first-run orientation for photographers
  • Better discoverability for technical customization topics
  • Less ambiguity in the docs navigation
  • A stronger, more differentiated product narrative for Revela

Open questions

  • Which topics should stay shared vs. live in the two persona paths?
  • Where should theme customization and plugin docs be split between simple and advanced guidance?
  • Do we want a dedicated persona landing page for each audience, or a docs hub that points to both paths?

Suggested next step

Validate the proposed structure against the current website sample and docs index, then implement the first persona-based navigation and landing pages.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions