Skip to content

Misleading comment #394

@FlagHunter01

Description

@FlagHunter01

Context

I have asked a moderator on Discord to make sure it's not an understanding issue on my end

Bug description

In zensical/python/zensical/bootstrap/zensical.toml:

# You can configure your own logo to be shown in the header using the "logo"
# option in the "icons" subsection. The logo can be a path to a file in your
# "docs_dir" or it can be a path to an icon.
# ----------------------------------------------------------------------------
#[project.theme.icon]
#logo = "lucide/smile"

This is inexact. In ui/src/partials/logo.html:

  • [project.theme] will indeed search in $docs_dir
  • [project.theme.icon] will search in .icons/

The behavior is correct, but this comment is misleading IMO.

I'd open a PR but idk how to write it best as English isn't my first nor second language ...

Related links

Reproduction

Create a new project with Zensical =< 0.0.23

Steps to reproduce

zensical new demoproject
cat demoproject/zensical.toml

Browser

No response

Before submitting

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationIssue concerns the documentationresolvedIssue is resolved, yet unreleased if open

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions