docs: improve getting_started and installation readability #30

Open

gillian wants to merge 6 commits from docs/sdr-guides-update into main

pull from: docs/sdr-guides-update

merge into: qoherent:main

qoherent:main

qoherent:agent-naming-fix

qoherent:zfp-oss

qoherent:screens-connection

qoherent:dataset-manager-v2

Conversation 0 Commits 6 Files Changed 10 +451 -441

G

G gillian commented 2026-04-24 14:36:38 -04:00

Owner

Copy Link

• Consolidate installation steps into installation.rst (pip upgrade,
  ria --help verification, entrypoints note, editable install note,
  SDR driver table); replace getting_started §1 body with a link
• Reformat command and subcommand lists as tables with purpose
  descriptions and internal ref links for navigation
• Remove redundant §6 tips and §9 cheat sheet; trim duplicate
  descriptions in generate subcommand sections
• Fix inline code comments to sit beside the command they describe
• Add custom CSS for light body text, white headings, and table
  header colour to suit the dark background theme

- Consolidate installation steps into installation.rst (pip upgrade, ria --help verification, entrypoints note, editable install note, SDR driver table); replace getting_started §1 body with a link - Reformat command and subcommand lists as tables with purpose descriptions and internal ref links for navigation - Remove redundant §6 tips and §9 cheat sheet; trim duplicate descriptions in generate subcommand sections - Fix inline code comments to sit beside the command they describe - Add custom CSS for light body text, white headings, and table header colour to suit the dark background theme

gillian added 1 commit 2026-04-24 14:36:38 -04:00

G docs: improve getting_started and installation readability ...

- Consolidate installation steps into installation.rst (pip upgrade,
  ria --help verification, entrypoints note, editable install note,
  SDR driver table); replace getting_started §1 body with a link
- Reformat command and subcommand lists as tables with purpose
  descriptions and internal ref links for navigation
- Remove redundant §6 tips and §9 cheat sheet; trim duplicate
  descriptions in generate subcommand sections
- Fix inline code comments to sit beside the command they describe
- Add custom CSS for light body text, white headings, and table
  header colour to suit the dark background theme

2c1fba75da

G gillian requested review from muq 2026-04-24 14:36:43 -04:00

gillian added 1 commit 2026-04-24 14:36:55 -04:00

G Merge branch 'main' into docs/sdr-guides-update a4cd158b2a

gillian added 1 commit 2026-04-28 11:28:50 -04:00

F docs: enhance getting started guide with example output and image reference 9a304faa00

gillian added 2 commits 2026-04-28 14:09:03 -04:00

G Changed datasets to data to match utils 4c94f6ae94

G refactor: unify signal viewer styling and update docs screenshots ...

- Align view_simple and view_full on background colour (#161616), title
  size (25pt), subtitle size (15pt), base font/tick/label sizes, grid
  style (alpha=0.2), and legend fontsize (10pt)
- Spectrogram placed above IQ plot in view_simple; subplot renamed from
  "Time Series" to "IQ Sample Plot"
- Frequency and spectrogram Y-axes formatted in MHz across both viewers
- Added xlabel/ylabel, subtle grids, and IQ legend to view_full subplots
- Fixed spectrogram right-side clipping in view_simple by syncing xlim
  from specgram output rather than total signal duration
- Updated getting_started.rst to reference both simple and full viewer
  screenshots; replaced doc images with latest renders

e5a3d327e5

madrigal added 1 commit 2026-04-29 09:55:40 -04:00

M Formatting, updated lock file 4ce42fa71a

M madrigal approved these changes 2026-04-29 10:00:07 -04:00

M madrigal left a comment

Member

Copy Link

Looks good

Looks good

All checks were successful

Hide all checks

Build Sphinx Docs Set / Build Docs (pull_request) Successful in 34s

Details

Build Project / Build Project (3.10) (pull_request) Successful in 1m42s

Details

Build Project / Build Project (3.11) (pull_request) Successful in 1m41s

Details

Build Project / Build Project (3.12) (pull_request) Successful in 1m46s

Details

Test with tox / Test with tox (3.11) (pull_request) Successful in 2m47s

Details

Test with tox / Test with tox (3.12) (pull_request) Successful in 2m32s

Details

Test with tox / Test with tox (3.10) (pull_request) Successful in 3m1s

Details

This pull request can be merged automatically.

You are not authorized to merge this pull request.

View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin docs/sdr-guides-update:docs/sdr-guides-update

git checkout docs/sdr-guides-update

Sign in to join this conversation.

Reviewers

No reviewers

Mmuq

Mmadrigal

Labels

Clear labels

  

CI/CD 🛠️

This issue relates to our automated testing, building, and publishing processes

  

WIP 🚧

Someone is currently worked on this issue

  

bug 🐞

There is a problem, error, or unexpected behaviour

  

code quality 🧹

This issues pertains to code quality improvements or tech debt reduction

  

data collection 🗃️

This issue involves machine learning data collection or filing

  

dependency 📦

This issue pertains to dependency changes or deprecation warnings

  

do not merge 🚫

This pull request is not to be merged

  

documentation 📝

Improvements or additions to documentation or tutorials

  

duplicate 🔄

This issue or pull request already exists

  

enhancement ✨

This issue is important and will require attention soon, but does not pose any immediate risks

  

good first issue 🌱

A good first issue for newcomers

  

help wanted 👋

Additional development support is required

  

inference 🧠

This issue involves designing or improving inference solutions

  

invalid 🛑

Something is wrong with this issue or it not does conform to project guidelines

  

machine learning 🚀

This issue pertains to and may require expertise in machine learning

  

priority

high🔥

This issue is critical and requires immediate attention to prevent further consequence or escalation

  

priority

low 🍃

  

priority

medium 🌟

This issue is important and will require attention soon, but does not pose any immediate risks

  

quantum ⚛️

This issue pertains to and may require expertise in quantum technology

  

question ❓

Additional information is required

  

radio 📡

This issue involves radio interface components and may requires access to radio hardware

  

sprintable 🏃‍♂️

This issue could be resolved in a single sprint

  

test 🧪

This issue pertains to our testing efforts

  

wont fix ❌

We've chosen not to address this issue

No Label

CI/CD 🛠️

WIP 🚧

bug 🐞

code quality 🧹

data collection 🗃️

dependency 📦

do not merge 🚫

documentation 📝

duplicate 🔄

enhancement ✨

good first issue 🌱

help wanted 👋

inference 🧠

invalid 🛑

machine learning 🚀

priority

high🔥

priority

low 🍃

priority

medium 🌟

quantum ⚛️

question ❓

radio 📡

sprintable 🏃‍♂️

test 🧪

wont fix ❌

Milestone

Clear milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

No Assignees

2 Participants

G M

Notifications

Subscribe

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: qoherent/ria-toolkit-oss#30

No description provided.