Skip to content

docs: correct stale config names and paths in paragon README#67

Open
kdmccormick wants to merge 1 commit into
mainfrom
kdmccormick/readme
Open

docs: correct stale config names and paths in paragon README#67
kdmccormick wants to merge 1 commit into
mainfrom
kdmccormick/readme

Conversation

@kdmccormick
Copy link
Copy Markdown
Member

Updates references to PARAGON_THEMES_PATH / PARAGON_THEMES to the actual config keys, fixes default values, separates source vs. compiled paths, and drops {{ TUTOR_ROOT }} (not a Jinja variable in Tutor).

Written by Claude, reviewed by me.

Updates references to `PARAGON_THEMES_PATH` / `PARAGON_THEMES` to the
actual config keys, fixes default values, separates source vs. compiled
paths, and drops `{{ TUTOR_ROOT }}` (not a Jinja variable in Tutor).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Comment on lines +123 to +124
``PARAGON_THEME_SOURCES_PATH``
Base path for theme sources. Default: ``env/plugins/paragon/theme-sources``.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Matches

("PARAGON_THEME_SOURCES_PATH", "env/plugins/paragon/theme-sources"),

👍

Comment on lines +126 to +127
``PARAGON_COMPILED_THEMES_PATH``
Base path for compiled output. Default: ``env/plugins/paragon/compiled-themes``.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Matches

("PARAGON_COMPILED_THEMES_PATH", "env/plugins/paragon/compiled-themes"),

👍

Comment on lines +129 to +130
``PARAGON_ENABLED_THEMES``
List of theme folders to compile and serve. Default: ``[]``.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Matches

and the "theme folders to compile" matches

if ! has_themes "$@"; then
if [ -n "${PARAGON_ENABLED_THEMES:-}" ]; then
echo "Using PARAGON_ENABLED_THEMES: ${PARAGON_ENABLED_THEMES}"
set -- "$@" --themes "${PARAGON_ENABLED_THEMES}"
fi
fi

but the "and serve" is a little misleading because of

{% if not PARAGON_ENABLED_THEMES %} {% set PARAGON_ENABLED_THEMES = ['light'] %} {% endif %}

{% if not PARAGON_ENABLED_THEMES %}{% set PARAGON_ENABLED_THEMES = ['light'] %}{% endif %}

{% if not PARAGON_ENABLED_THEMES %} {% set PARAGON_ENABLED_THEMES = ['light'] %} {% endif %}

{% if not PARAGON_ENABLED_THEMES %} {% set PARAGON_ENABLED_THEMES = ['light'] %} {% endif %}


Not sure the best way to address this, and this is better than the definitely incorrect ['light', 'dark'] so I don't think we should block this PR on it, but worth digging into/making a follow-up issue for.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants