fix: improved layout of tables to extend to the right side of page #41
Conversation
📝 WalkthroughWalkthroughThe changes introduce a new layout template for documentation rendering and update existing markdown templates to include YAML front matter for metadata and improved table responsiveness. The README is expanded with detailed contributor instructions, including environment setup and the standard Git workflow. The new layout template provides conditional rendering of the main content area based on metadata, enhancing flexibility for documentation pages. No changes were made to exported or public entities in the codebase. Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor
participant GitHub
participant LocalRepo
participant CondaEnv
Contributor->>GitHub: Fork repository
Contributor->>LocalRepo: Clone fork locally
Contributor->>CondaEnv: Set up conda environment
Contributor->>LocalRepo: Configure environment variables
Contributor->>LocalRepo: Build catalog data sources
Contributor->>LocalRepo: Generate catalog web page
Contributor->>LocalRepo: Stage, commit, and push changes
Contributor->>GitHub: Create pull request
sequenceDiagram
participant DocRenderer
participant layout.html
participant meta
DocRenderer->>layout.html: Render page
layout.html->>meta: Check for 'notoc'
alt meta contains 'notoc'
layout.html->>DocRenderer: Render <main> with simple padding
else
layout.html->>DocRenderer: Render <main> with grid layout and padding
end
layout.html->>DocRenderer: Render body block
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_templates/all_other_workflows.md (1)
1-4: Duplicate front‑matter check
Same as inall_standardized_workflows.md: ensure your MyST/Sphinx setup is correctly parsing the YAML front‑matter so thenotocflag is available to the layout template.
🧹 Nitpick comments (7)
README.md (7)
64-65: Split long sentence for clarity
This sentence is quite long and conflates two ideas. Consider breaking it into two separate sentences for readability.-Ideas can be discussed on the [catalog's Issues page](https://github.com/snakemake/snakemake-workflow-catalog/issues) first, and contributions made through Github Pull Requests, see the [next section](#working-with-a-local-copy) for details. +You can first discuss ideas on the [catalog's Issues page](https://github.com/snakemake/snakemake-workflow-catalog/issues). Contributions should then be submitted via GitHub Pull Requests—see the [Working with a local copy](#working-with-a-local-copy) section below.
66-69: Shorten heading and intro phrasing
The heading and lead‑in can be more concise. For example:-## Working with a local copy -In order to make contributions, you can set up a local copy of the catalog and test your changes. +## Local setup -To contribute, clone and build a local copy of the catalog to test your changes.🧰 Tools
🪛 LanguageTool
[style] ~67-~67: Consider a shorter alternative to avoid wordiness.
Context: ...details. ## Working with a local copy In order to make contributions, you can set up a lo...(IN_ORDER_TO_PREMIUM)
73-73: Hyphenate compound adjective
In “top right corner”, use a hyphen for the compound modifier:-Click on the "Fork" button in the top right corner … +Click on the "Fork" button in the top‑right corner …🧰 Tools
🪛 LanguageTool
[uncategorized] ~73-~73: Consider adding a hyphen.
Context: ...b. 2. Click on the "Fork" button in the top right corner ([Github documentation: Forking ...(TOP_LEFT_CORNER)
82-82: Condense environment setup instruction
The phrase “in order to work with the catalog locally” is verbose. Consider:-1. Create a conda/mamba environment in order to work with the catalog locally. +1. Create a conda/mamba environment for the catalog.🧰 Tools
🪛 LanguageTool
[style] ~82-~82: Consider a shorter alternative to avoid wordiness.
Context: ...g: 1. Create a conda/mamba environment in order to work with the catalog locally. ```bash...(IN_ORDER_TO_PREMIUM)
90-90: Fix missing preposition
Add “to” for correct grammar and clarity:-The variable `TEST_REPO` is used fetch only data from a single workflow. +The variable `TEST_REPO` is used to fetch data from a single workflow.🧰 Tools
🪛 LanguageTool
[uncategorized] ~90-~90: Possible missing preposition found.
Context: ...ables. The variableTEST_REPOis used fetch only data from a single workflow. **...(AI_HYDRA_LEO_MISSING_TO)
119-121: Group Git steps for brevity
Three successive “Run” steps can be combined to reduce repetition:-5. Run `git add .` to stage your changes. -6. Run `git commit -m "fix: your commit message"` to commit your changes. -7. Run `git push` to push your changes to your fork on Github. +5. Stage, commit, and push your changes: + ```bash + git add . + git commit -m "fix: your commit message" + git push + ```🧰 Tools
🪛 LanguageTool
[style] ~121-~121: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...it message"to commit your changes. 7. Rungit push` to push your changes to your...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
144-144: Use period instead of exclamation for tone
For consistency with professional documentation, replace the exclamation point with a period:-Note: All workflows collected and presented on the Catalog are licensed under their own terms! +Note: All workflows collected and presented on the Catalog are licensed under their own terms.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
README.md(2 hunks)source/_templates/all_other_workflows.md(1 hunks)source/_templates/all_standardized_workflows.md(1 hunks)source/_templates/layout.html(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~67-~67: Consider a shorter alternative to avoid wordiness.
Context: ...details. ## Working with a local copy In order to make contributions, you can set up a lo...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~73-~73: Consider adding a hyphen.
Context: ...b. 2. Click on the "Fork" button in the top right corner ([Github documentation: Forking ...
(TOP_LEFT_CORNER)
[style] ~82-~82: Consider a shorter alternative to avoid wordiness.
Context: ...g: 1. Create a conda/mamba environment in order to work with the catalog locally. ```bash...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~90-~90: Possible missing preposition found.
Context: ...ables. The variable TEST_REPO is used fetch only data from a single workflow. **...
(AI_HYDRA_LEO_MISSING_TO)
[style] ~121-~121: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...it message"to commit your changes. 7. Rungit push` to push your changes to your...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (6)
source/_templates/layout.html (3)
1-4: Verify parent template inclusion and block override
The use of{% extends "!layout.html" %}combined with{{ super() }}looks correct to pull in the base layout content before defining your ownmainblock. Ensure that the!layout.htmlpath matches the theme’s template lookup (the!prefix is specific to sphinxawesome).
5-10: Validate conditional TOC logic and metadata access
Theif meta is defined and meta is not none and 'notoc' in metacheck drives whether we drop the sidebar and expand the content width. Please verify in a rendered page thatmetaindeed contains the front‑matter keys (e.g.notoc) and that this condition fires as intended. You might also simplify to something likeif meta.get('notoc')ifmetais always a dict.
11-13: Approve body block placeholder
Defining an inner{% block body %}allows page templates to inject their content inside your<main>wrapper. This pattern aligns with Jinja/Sphinx best practices.source/_templates/all_standardized_workflows.md (2)
1-4: Ensure front‑matter is parsed by MyST/Sphinx
You’ve added YAML front‑matter (notoc: true,description: ...). Confirm that your Sphinx/MyST configuration includesmyst_enable_extensions = ["front_matter"](or equivalent) so this metadata is available in themetacontext for the new layout template.
13-13: Standardize table width to responsive 100%
Switching:width:from a fixed135%to100%ensures the table will adapt to the container width without horizontal scrolling. This change aligns with the new layout and is approved.source/_templates/all_other_workflows.md (1)
13-13: Table width update approved
Changing the:width:attribute to100%standardizes table sizing in line with the new layout and removes unnecessary overflow.
|
@cademirch thank you for reviewing! - have seen my GitHub notification too late. |
Summary by CodeRabbit