Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe how Publ works, exactly #33

Open
fluffy-critter opened this issue Aug 20, 2023 · 0 comments
Open

Describe how Publ works, exactly #33

fluffy-critter opened this issue Aug 20, 2023 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@fluffy-critter
Copy link
Collaborator

There needs to be a high-level overview of how Publ works, as users seem to be confused about how the template is selected and how content is floated up to it.

It should touch on things like:

  • Index and entry templates
  • Template overrides for both
  • Entry resolution
  • Category metadata
  • Path aliases (and the difference between alias, mount, and canonical)
  • Special templates (login, error handlers)
  • Application-level extensions (e.g. Novembeat's submission system)
  • Image renditions

Currently there's a lot of low-level usage stuff for things that people already know about but no signposts to point people to from a high level. Bottom-up documentation only makes sense to the implementers of a system.

@fluffy-critter fluffy-critter added enhancement New feature or request help wanted Extra attention is needed labels Aug 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant