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

Updating link to project docs #31

Merged
merged 6 commits into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/CODING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ tests. In the meantime, please format your C code in accordance with [Google's C

### Documentation guidelines

We use [Sphinx](https://www.sphinx-doc.org/en/master/) to auto-generate the project's [docs](http://docs.radiointelligence.io/). All docstrings must adhere to the
We use [Sphinx](https://www.sphinx-doc.org/en/master/) to auto-generate the project's [docs](https://radiointelligence.io/). All docstrings must adhere to the
[Sphinx docstring format](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html#the-sphinx-docstring-format).

Types mentioning in the docstring should be expressed in plain English rather than using Python's type hint syntax
Expand Down Expand Up @@ -93,7 +93,7 @@ Please keep your pull requests concise and focused. We recommend limiting your p

## Building docs

We use [Sphinx](https://www.sphinx-doc.org/en/master/) to auto-generate the project's [docs](http://docs.radiointelligence.io/). When making changes, we use `sphinx-autobuild` to
We use [Sphinx](https://www.sphinx-doc.org/en/master/) to auto-generate the project's [docs](https://radiointelligence.io/). When making changes, we use `sphinx-autobuild` to
auto-detect these changes. This means you only need to build the docs once, and any changes to the source code or
configurations are live-reload in the browser.

Expand Down
2 changes: 1 addition & 1 deletion .github/DIVERSITY_STATEMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ all abilities. We welcome feedback and suggestions for improving accessibility t
Our standards for behaviour are detailed in the project's [Code of Conduct](./CODE_OF_CONDUCT.md).
We kindly insist all participants uphold these standards in all their interactions and communications.

Let's build intelligent radios, together! 📡🚀
Let's build intelligent radios together.™ 📡🚀
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,17 @@

<h3 align="center">Radio Intelligence Apps, By <a href="https://www.qoherent.ai/">Qoherent</a></h3>

<h4 align="center">Let's build intelligent radios together 📡🚀</h4>
<h4 align="center">Let's build intelligent radios together. 📡🚀</h4>

<p align="center">
<!-- PyPI -->
<a href="https://pypi.org/project/ria">
<img src="https://img.shields.io/pypi/v/ria"/>
</a>
<!-- Conda-Forge -->
<a href="https://anaconda.org/conda-forge/ria">
<img src="https://img.shields.io/conda/vn/conda-forge/ria"/>
</a>
<!-- License -->
<a href="https://www.gnu.org/licenses/agpl-3.0">
<img src="https://img.shields.io/badge/License-AGPLv3-blue.svg" />
Expand All @@ -21,7 +25,7 @@
<img src="https://img.shields.io/pypi/status/ria"/>
</a>
<!-- Docs -->
<a href="http://docs.radiointelligence.io/">
<a href="https://radiointelligence.io/">
<img src="https://img.shields.io/badge/docs-ria--core-blue"/>
</a>
</p>
Expand Down Expand Up @@ -82,7 +86,7 @@ conda install ria

Interfacing with your local SDR hardware may require additional drivers and configurations.

Please refer to the [documentation](http://docs.radiointelligence.io/) for more information on getting
Please refer to the [documentation](https://radiointelligence.io/) for more information on getting
started with RIA Core.


Expand Down Expand Up @@ -150,7 +154,7 @@ lte_nr_classifier.to_onnx("models/classifier.onnx")
If RIA's syntax feels familiar, that's because RIA is built on [PyTorch](https://pytorch.org/docs/stable/data.html)
and [PyTorch Lightning](https://lightning.ai/docs/pytorch/stable/)!

Please refer to the [documentation](http://docs.radiointelligence.io/) for additional usage examples. If you
Please refer to the [documentation](https://radiointelligence.io/) for additional usage examples. If you
encounter any difficulties, don't hesitate to reach out on our open [support forum](https://github.com/qoherent/ria/discussions/categories/support).

Additional back-ends can be made available. Please [contact us](https://www.qoherent.ai/contact/) for further details.
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/source/marketing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ Marketing
:maxdepth: 2
:caption: Contents:

RIA Hub <riahub>
RIA RAN <riaran>
RIA Suite <riasuite>
6 changes: 6 additions & 0 deletions docs/source/marketing/riahub.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
RIA Hub
=======

.. todo::

Introduction to and marketing materials for RIA Hub.
6 changes: 0 additions & 6 deletions docs/source/marketing/riasuite.rst

This file was deleted.

4 changes: 2 additions & 2 deletions meta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ about:
congested, contested, and complex wireless spectrum.
license: AGPL-3.0-or-later
license_file: LICENSE
dev_url: https://github.com/qoherent/ria
doc_url: http://docs.radiointelligence.io/
dev_url: https://github.com/qoherent/ria/
doc_url: https://radiointelligence.io/

extra:
recipe-maintainers:
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[tool.poetry]
name = "ria"
version = "0.1.2"
description = "Let's build intelligent radios together. 📡🚀"
description = "Radio Intelligence Apps' open-source core, by Qoherent 📡🚀"
readme = "README.md"
license = "AGPL-3.0-or-later"
keywords = [
Expand Down Expand Up @@ -62,7 +62,7 @@ isort = "^5.13.2"

[tool.poetry.urls]
"Qoherent" = "https://www.qoherent.ai/"
"Documentation" = "http://docs.radiointelligence.io/"
"Documentation" = "https://radiointelligence.io/"
"Source" = "https://github.com/qoherent/ria"
"Issues" = "https://github.com/qoherent/ria/issues"

Expand Down
Loading