-
Notifications
You must be signed in to change notification settings - Fork 95
Misleading comment #394
Copy link
Copy link
Closed
Labels
documentationIssue concerns the documentationIssue concerns the documentationresolvedIssue is resolved, yet unreleased if openIssue is resolved, yet unreleased if open
Description
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
- I have read and followed the bug reporting guidelines.
- I have attached links to the documentation, and possibly related issues.
- I assure that I have removed all customizations before submitting this bug report.
- I have attached a .zip file with a minimal reproduction.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationIssue concerns the documentationIssue concerns the documentationresolvedIssue is resolved, yet unreleased if openIssue is resolved, yet unreleased if open