doc improvements #544

d-chambers · 2025-09-20T13:43:49Z

Description

This PR fixes a few typos in the docs and makes the DASCore landing page a bit less cluttered.

Checklist

I have (if applicable):

referenced the GitHub issue this PR closes.
documented the new feature with docstrings or appropriate doc page.
included a test. See testing guidelines.
your name has been added to the contributors page (docs/contributors.md).
added the "ready_for_review" tag once the PR is ready to be reviewed.

Summary by CodeRabbit

Documentation
- Added a dedicated "Supported Formats" page with a styled table and linked it from the site navigation.
- Updated Highlights to state DASCore is part of the DASDAE ecosystem and removed the homepage "Supported file formats" section (intro usage unchanged).
- Replaced manual contributor list with a GitHub contributors badge; simplified changelog blurb.
- Clarified caching phrasing and fixed typos/wording across tutorials and notes.

coderabbitai · 2025-09-20T13:44:06Z

Walkthrough

Documentation updates: index and Highlights wording changed, the “Supported file formats” section removed and replaced by a new docs/supported_formats.qmd page that programmatically renders the formats table, plus multiple minor copy fixes across notes, recipes, tutorials, changelog, and contributors; sidebar navigation updated to include Formats.

Changes

Cohort / File(s)	Summary of Changes
Docs index and highlights `docs/index.qmd`	Replaced first bullet with a link to supported formats, updated Highlights callout text to reference the DASDAE ecosystem, and removed the “Supported file formats” section and its Python snippet; remaining intro/usage content unchanged.
New supported formats page `docs/supported_formats.qmd`	Added page that builds a supported I/O formats table via `FiberIO.get_supported_io_table()`, substitutes booleans with ✅/❌, converts to Markdown with centered alignment, appends `{.striped}`, and prints the output.
Sidebar navigation update `scripts/_templates/_quarto.yml`	Added an About → Formats navigation entry pointing to `supported_formats.qmd`.
Minor docs copy fixes `docs/notes/dft_notes.qmd`, `docs/recipes/contributing_to_documentation.qmd`, `docs/tutorial/patch.qmd`, `docs/tutorial/processing.qmd`, `docs/tutorial/visualization.qmd`, `docs/changelog.qmd`, `docs/contributors.qmd`	Small wording, typo, capitalization, and link-text fixes (e.g., “Sclaing”→“Scaling”; caching sentence clarification; “manages” correction; `Patch.dropna` link formatting; “Wiggle” heading; changelog preface replaced with single line; contributors list replaced by GitHub badge/link). No code/API changes.

Possibly related PRs

fix documentation typos #540 — Also touches docs/contributors.qmd (fixes header text and broken contributor URLs), likely related to the contributors-list changes in this PR.

Suggested labels

ready_for_review

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The provided title "doc improvements" is related to the changeset because the PR edits documentation, but it is overly generic and does not highlight the main changes (for example, adding docs/supported_formats.qmd, updating site navigation, removing the "Supported file formats" section on the landing page, and several typo fixes). As written, it does not give a reviewer or future reader a clear, scannable summary of the primary intent of the PR. Because the repository expects a concise, specific statement of the main change, the title is inconclusive.	Please replace the title with a short, descriptive imperative phrase that summarizes the primary change; for example: "docs: add supported formats page and simplify landing page" or "docs: add supported_formats.qmd, update nav, and fix typos". Include the most important change first and keep it concise so reviewers can understand the PR at a glance.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	The PR description includes the required "## Description" section and the checklist from the repository template and clearly states the high-level intent (fix typos and simplify the landing page), so it meets the basic template structure. However it omits reviewer-useful specifics such as links to any related issue/discussion, a short list of the key files changed (e.g., docs/supported_formats.qmd and scripts/_templates/_quarto.yml), and whether tests or tagging (ready_for_review) were added. Given those omissions but overall presence of the template sections, the description is mostly complete but would benefit from a few concrete details to improve reviewability.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch doc_improvements

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 84ec6cb and 62b5e48.

📒 Files selected for processing (3)

docs/changelog.qmd (1 hunks)
docs/contributors.qmd (1 hunks)
scripts/_templates/_quarto.yml (1 hunks)

✅ Files skipped from review due to trivial changes (2)

docs/contributors.qmd
docs/changelog.qmd

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: test_build_docs

🔇 Additional comments (1)

scripts/_templates/_quarto.yml (1)
79-81: Change nav label to "Supported Formats" — verified.

docs/supported_formats.qmd exists (title: "Supported File Formats"); no stale index anchor links found; only plain-text occurrence is the page title.
-        - text: Formats
+        - text: Supported Formats
           href: supported_formats.qmd

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/tutorial/processing.qmd (1)

171-171: Capitalize NaN for consistency.

Apply:

-Notice the nan values at the start of the time axis. These can be trimmed with [`Patch.dropna`](`dascore.Patch.dropna`).
+Notice the NaN values at the start of the time axis. These can be trimmed with [`Patch.dropna`](`dascore.Patch.dropna`).

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 272d0e7 and 84ec6cb.

📒 Files selected for processing (7)

docs/index.qmd (1 hunks)
docs/notes/dft_notes.qmd (1 hunks)
docs/recipes/contributing_to_documentation.qmd (1 hunks)
docs/supported_formats.qmd (1 hunks)
docs/tutorial/patch.qmd (1 hunks)
docs/tutorial/processing.qmd (2 hunks)
docs/tutorial/visualization.qmd (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: test_build_docs

🔇 Additional comments (8)

docs/tutorial/patch.qmd (1)

135-135: Grammar fix LGTM.

“manages” reads correctly and improves clarity.

docs/notes/dft_notes.qmd (1)

268-268: Typo fix LGTM.

“Scaling of DFT” link text corrected.

docs/recipes/contributing_to_documentation.qmd (1)

40-40: Wording fix LGTM.

Reads clearly now.

docs/tutorial/processing.qmd (1)

274-274: Sentence tweak LGTM.

Pluralization and clarity improved.

docs/index.qmd (2)

21-21: Callout wording LGTM.

Ecosystem phrasing is concise and accurate.

16-16: Link to supported formats — path valid; no stale references found.
docs/supported_formats.qmd exists; the only reference found is docs/index.qmd:16.

docs/tutorial/visualization.qmd (1)

22-22: Heading capitalization — confirm anchor stability for "Wiggle" (docs/tutorial/visualization.qmd:22).

Repository search returned no matches for "#wiggle". Manually verify inbound links to visualization.qmd#wiggle (or built visualization.html#wiggle) still resolve and update links or the heading slug if needed.
docs/supported_formats.qmd (1)
7-16: Make boolean replacement safer and center numeric columns.

Only replace boolean dtypes to avoid converting numeric 0/1; center numeric columns with numalign.

File: docs/supported_formats.qmd (lines 7–16)
 ```{python}
 #| echo: false
 #| output: asis
-import pandas as pd
 from dascore.io.core import FiberIO
-out_str = FiberIO.get_supported_io_table().replace(True, value='✅').replace(False, value='❌').to_markdown(index=False, stralign="center")
+df = FiberIO.get_supported_io_table()
+# Only replace boolean columns
+bool_cols = df.select_dtypes(include="bool").columns
+df[bool_cols] = df[bool_cols].replace({True: "✅", False: "❌"})
+out_str = df.to_markdown(index=False, stralign="center", numalign="center")
 
 out_str += '\n: {.striped}'
 print(out_str)
Verification: sandbox lacks Quarto ("/bin/bash: line 2: quarto: command not found"); run locally: quarto preview docs/supported_formats.qmd to confirm emoji rendering and styling.

</blockquote></details>

</blockquote></details>

</details>

github-actions · 2025-09-20T14:07:55Z

✅ Documentation built:
👉 Download
Note: You must be logged in to github and a DASDAE member to access the link.

doc improvements

84ec6cb

d-chambers added the documentation Improvements or additions to documentation label Sep 20, 2025

coderabbitai bot reviewed Sep 20, 2025

View reviewed changes

rabit review, changelog and contributors

62b5e48

coderabbitai bot added the ready_for_review PR is ready for review label Sep 20, 2025

d-chambers merged commit b766f2e into master Sep 20, 2025
3 checks passed

d-chambers deleted the doc_improvements branch September 20, 2025 15:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

doc improvements #544

doc improvements #544

Uh oh!

d-chambers commented Sep 20, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Sep 20, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

github-actions bot commented Sep 20, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

doc improvements #544

doc improvements #544

Uh oh!

Conversation

d-chambers commented Sep 20, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested labels

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

d-chambers commented Sep 20, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 20, 2025 •

edited

Loading

github-actions bot commented Sep 20, 2025 •

edited

Loading