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

✏️ Fix overrides page #53

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

ebouchut
Copy link
Collaborator

@ebouchut ebouchut commented Jan 31, 2025

This PR:

  • ✏️ Fixes the Overrides page
  • Add an info box that matches the names in the application and the documentation that refer to the same concept. For instance, Override = Preset.

    Correspondance Table

  • Remove the Workout override section as it is not a baked-in feature of Loop,
  • Adds the "Adding a Custom Override Preset" section (rework of the old Workout Override section).
  • 🚚 renames the Overrides page as Presets,
  • ⚙️ redirects the old overrides.md to the new presets.md page,
  • ➕ adds the mkdocs-redirects plugin,
  • ⬆️ upgrades dependencies,
  • 🎨 Fix indentation in mkdocs.yml.

@ebouchut ebouchut added config dependencies Pull requests that update a dependency file typo labels Jan 31, 2025
@ebouchut ebouchut self-assigned this Jan 31, 2025
Redirect overrides.md to presets.md
@ebouchut ebouchut force-pushed the fix/overrides_presets branch 3 times, most recently from bf385d2 to a10f286 Compare January 31, 2025 18:33
Loop does not have a baked-in Workout Preset.
Rename "Workout Targets" section as "Creating a Custom Preset"
that explains how to create a custom Workout Preset.
@ebouchut ebouchut force-pushed the fix/overrides_presets branch from a10f286 to f65e1f5 Compare January 31, 2025 18:56
@ebouchut
Copy link
Collaborator Author

ebouchut commented Jan 31, 2025

@ellenbroadman You can review what the updated page looks like here.

@ebouchut
Copy link
Collaborator Author

ebouchut commented Feb 4, 2025

Later, we should revise Loop documentation to consistently use the term Preset as it appears in the application, eliminating Override.

We are not there yet.
This PR is the first step, which includes a correspondence table linking the names in the application to those in the documentation that refer to the same concept.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
config dependencies Pull requests that update a dependency file typo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant