Skip to content

Commit

Permalink
chore: Fixed docs links to point to the new subdomain
Browse files Browse the repository at this point in the history
  • Loading branch information
hmahmood24 committed Sep 25, 2024
1 parent 1f1e2cb commit ba8a081
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 40 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/docs_bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ body:
attributes:
label: Path
description: "Path to the documentation which have the issue. Can be a documentation URL or path to docstring (file::function-name)."
placeholder: https://unify.ai/docs/ivy/, ivy\functional\ivy\activations.py::relu
placeholder: https://docs.ivy.dev, ivy\functional\ivy\activations.py::relu
validations:
required: true
- type: input
Expand Down
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ that your pre-commit check has some failures.
Here are some relevant resources regarding tests and pre-commit:
https://unify.ai/docs/ivy/overview/deep_dive/ivy_tests.html
https://unify.ai/docs/ivy/overview/deep_dive/formatting.html#pre-commit
https://docs.ivy.dev/overview/deep_dive/ivy_tests.html
https://docs.ivy.dev/overview/deep_dive/formatting.html#pre-commit
-->

Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Please, follow the next process when you work on your subtask:

Currently, there are three open tasks:

- [Function Reformatting](https://unify.ai/docs/ivy/overview/contributing/open_tasks.html#function-formatting)
- [Frontend APIs](https://unify.ai/docs/ivy/overview/contributing/open_tasks.html#frontend-apis)
- [Ivy Experimental API](https://unify.ai/docs/ivy/overview/contributing/open_tasks.html#ivy-experimental-api)
- [Function Reformatting](https://docs.ivy.dev/overview/contributing/open_tasks.html#function-formatting)
- [Frontend APIs](https://docs.ivy.dev/overview/contributing/open_tasks.html#frontend-apis)
- [Ivy Experimental API](https://docs.ivy.dev/overview/contributing/open_tasks.html#ivy-experimental-api)

2. **Create Issue:**

Expand Down
49 changes: 24 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,32 +16,32 @@
<a href="https://ivy.dev/" style="text-decoration: none;">Website</a>
</td>
<td align="center">
<a href="https://ivy.dev/docs">
<a href="https://docs.ivy.dev/">
<img class="dark-light" width="70" src="https://raw.githubusercontent.com/ivy-llc/assets/refs/heads/main/assets/docs.svg" alt="Docs">
</a>
<br>
<a href="https://ivy.dev/docs" style="text-decoration: none;">Docs</a>
<a href="https://docs.ivy.dev/" style="text-decoration: none;">Docs</a>
</td>
<td align="center">
<a href="https://ivy.dev/docs/demos">
<a href="https://docs.ivy.dev/demos">
<img class="dark-light" width="75" src="https://raw.githubusercontent.com/ivy-llc/assets/refs/heads/main/assets/demos.svg" alt="Demos">
</a>
<br>
<a href="https://ivy.dev/docs/demos" style="text-decoration: none;">Demos</a>
<a href="https://docs.ivy.dev/demos" style="text-decoration: none;">Demos</a>
</td>
<td align="center">
<a href="https://ivy.dev/docs/overview/design">
<a href="https://docs.ivy.dev/overview/design.html">
<img class="dark-light" width="75" src="https://raw.githubusercontent.com/ivy-llc/assets/refs/heads/main/assets/design.svg" alt="Design">
</a>
<br>
<a href="https://ivy.dev/docs/overview/design" style="text-decoration: none;">Design</a>
<a href="https://docs.ivy.dev/overview/design.html" style="text-decoration: none;">Design</a>
</td>
<td align="center">
<a href="https://ivy.dev/docs/overview/faq">
<a href="https://docs.ivy.dev/overview/faq.html">
<img class="dark-light" width="75" src="https://raw.githubusercontent.com/ivy-llc/assets/refs/heads/main/assets/faq.svg" alt="FAQ">
</a>
<br>
<a href="https://ivy.dev/docs/overview/faq" style="text-decoration: none;">FAQ</a>
<a href="https://docs.ivy.dev/overview/faq.html" style="text-decoration: none;">FAQ</a>
</td>
</tr>
</table>
Expand Down Expand Up @@ -138,7 +138,7 @@ pip install --user -e .
```

If you want to set up testing and various frameworks it\'s probably best
to check out the [Setting Up](https://ivy.dev/docs/overview/contributing/setting_up.html)
to check out the [Setting Up](https://docs.ivy.dev/overview/contributing/setting_up.html)
page, where OS-specific and IDE-specific instructions and video
tutorials to do so are available!

Expand All @@ -162,19 +162,19 @@ We're working hard on adding support for more frameworks, let us know on [Discor

# Getting started

- [Docs](https://ivy.dev/docs)
- [Demos](https://ivy.dev/demos)
- [FAQ](https://ivy.dev/docs/overview/faq.html)
- [Docs](https://docs.ivy.dev/)
- [Demos](https://docs.ivy.dev/demos)
- [FAQ](https://docs.ivy.dev/overview/faq.html)

[Ivy's transpiler](https://ivy.dev/docs/overview/design/ivy_as_a_transpiler.html) allows you convert code between different ML frameworks. Have a look at our [Quickstart](https://ivy.dev/docs/demos/quickstart.html) notebook to get a brief idea of the features!
[Ivy's transpiler](https://docs.ivy.dev/overview/design/ivy_as_a_transpiler.html) allows you convert code between different ML frameworks. Have a look at our [Quickstart](https://docs.ivy.dev/demos/quickstart.html) notebook to get a brief idea of the features!

Beyond that, based on the frameworks you want to convert code between, there are a few more [examples](#using-ivy) further down this page 👇 which contain a number of models and libraries transpiled between PyTorch, JAX, TensorFlow and NumPy.

<br>

# Using ivy

Here's some examples, to help you get started using Ivy! The [examples page](https://ivy.dev/docs/demos/) also features a wide range of
Here's some examples, to help you get started using Ivy! The [examples page](https://docs.ivy.dev/demos/) also features a wide range of
demos and tutorials showcasing some more use cases for Ivy.

<details>
Expand Down Expand Up @@ -1202,21 +1202,20 @@ ret = lazy_graph(x1)

If you want to learn more, you can find more information in the [Ivy as
a transpiler section of the
docs!](https://ivy.dev/docs/overview/design/ivy_as_a_transpiler.html)
docs!](https://docs.ivy.dev/overview/design/ivy_as_a_transpiler.html)


<br>

# Documentation

You can find Ivy's documentation on the [Docs page](https://ivy.dev/docs/), which includes:
- [Motivation](https://ivy.dev/docs/overview/motivation.html): This contextualizes the problem Ivy is trying to solve by going over
- The current [ML Explosion](https://ivy.dev/docs/overview/motivation/ml_explosion.html#ml-explosion).
- Explaining why it is important [to solve this problem](https://ivy.dev/docs/overview/motivation/why_unify.html#why-unify).
- Explaining how we adhere to existing [standards](https://ivy.dev/docs/overview/motivation/standardization.html#standardization) to make this happen.
- [Related Work](https://ivy.dev/docs/overview/related_work.html): Which paints a picture of the role Ivy plays in the ML stack, comparing it to other existing solutions in terms of functionalities and abstraction level.
- [Design](https://ivy.dev/docs/overview/design.html): A user-focused guide about the design decision behind the architecture and the main building blocks of Ivy.
- [Deep Dive](https://ivy.dev/docs/overview/deep_dive.html): Which delves deeper into the implementation details of Ivy and is oriented towards potential contributors to the code base.
You can find Ivy's documentation on the [Docs page](https://docs.ivy.dev/), which includes:
- [Motivation](https://docs.ivy.dev/overview/motivation.html): This contextualizes the problem Ivy is trying to solve by going over
- The current [ML Explosion](https://docs.ivy.dev/overview/motivation/ml_explosion.html#ml-explosion).
- Explaining why it is important [to solve this problem](https://www.docs.ivy.dev/overview/motivation/why_transpile.html#why-transpile).
- [Related Work](https://docs.ivy.dev/overview/related_work.html): Which paints a picture of the role Ivy plays in the ML stack, comparing it to other existing solutions in terms of functionalities and abstraction level.
- [Design](https://docs.ivy.dev/overview/design.html): A user-focused guide about the design decision behind the architecture and the main building blocks of Ivy.
- [Deep Dive](https://docs.ivy.dev/overview/deep_dive.html): Which delves deeper into the implementation details of Ivy and is oriented towards potential contributors to the code base.


<br>
Expand All @@ -1227,8 +1226,8 @@ We believe that everyone can contribute and make a difference. Whether
it\'s writing code, fixing bugs, or simply sharing feedback,
your contributions are definitely welcome and appreciated 🙌

Check out all of our [Open Tasks](https://ivy.dev/docs/overview/contributing/open_tasks.html),
and find out more info in our [Contributing guide](https://ivy.dev/docs/overview/contributing.html)
Check out all of our [Open Tasks](https://docs.ivy.dev/overview/contributing/open_tasks.html),
and find out more info in our [Contributing guide](https://docs.ivy.dev/overview/contributing.html)
in the docs! Or to immediately dive into a useful task, look for any failing tests on our [Test Dashboard](https://github.com/ivy-llc/ivy-tests-dashboard/blob/main/DASHBOARD.md)!


Expand Down
2 changes: 1 addition & 1 deletion automation_tools/checklists/frontend_checklist.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

## Frontend Task Checklist
#### IMPORTANT NOTICE 🚨:
The [Ivy Docs](https://unify.ai/docs/ivy/) represent the ground truth for the task descriptions and this checklist should only be used as a supplementary item to aid with the review process.
The [Ivy Docs](https://docs.ivy.dev/) represent the ground truth for the task descriptions and this checklist should only be used as a supplementary item to aid with the review process.

Please note that the contributor is not expected to understand everything in the checklist. It's mainly here for the reviewer to make sure everything has been done correctly 🙂

Expand Down
10 changes: 5 additions & 5 deletions automation_tools/checklists/reformat_checklist.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

## Reformatting Task Checklist
#### IMPORTANT NOTICE 🚨:
The [Ivy Docs](https://unify.ai/docs/ivy/) represent the ground truth for the task descriptions and this checklist should only be used as a supplementary item to aid with the review process.
The [Ivy Docs](https://docs.ivy.dev/) represent the ground truth for the task descriptions and this checklist should only be used as a supplementary item to aid with the review process.

#### LEGEND 🗺:
- ❌ : Check item is not completed.
Expand All @@ -25,21 +25,21 @@ The [Ivy Docs](https://unify.ai/docs/ivy/) represent the ground truth for the ta
6. - [ ] ❌: The `ivy.Container` special method in [ivy/data_classes/container/container.py](https://github.com/unifyai/ivy/blob/main/ivy/data_classes/container/container.py).
7. - [ ] ❌: The `ivy.Container` reverse special method in [ivy/data_classes/container/container.py](https://github.com/unifyai/ivy/blob/main/ivy/data_classes/container/container.py).
3. - [ ] ❌: Make sure that the aforementioned methods are added into the correct category-specific parent class, such as `ivy.ArrayWithElementwise`, `ivy.ContainerWithManipulation` etc.
4. - [ ] ❌: Correct all of the [Function Arguments and the type hints](https://unify.ai/docs/ivy/overview/deep_dive/function_arguments.html#function-arguments) for every function **and** its _relevant methods_, including those you did not implement yourself.
5. - [ ] ❌: Add the correct [Docstrings](https://unify.ai/docs/ivy/overview/deep_dive/docstrings.html#docstrings) to every function **and** its _relevant methods_, including those you did not implement yourself. The following should be added:
4. - [ ] ❌: Correct all of the [Function Arguments and the type hints](https://docs.ivy.dev/overview/deep_dive/function_arguments.html#function-arguments) for every function **and** its _relevant methods_, including those you did not implement yourself.
5. - [ ] ❌: Add the correct [Docstrings](https://docs.ivy.dev/overview/deep_dive/docstrings.html#docstrings) to every function **and** its _relevant methods_, including those you did not implement yourself. The following should be added:
1. - [ ] ❌: <a name="ref1"></a> The function's [Array API standard](https://data-apis.org/array-api/latest/index.html) description in [ivy/functional/{{ .category_name }}.py](https://github.com/unifyai/ivy/blob/main/ivy/functional/ivy/{{ .category_name }}.py). If the function is not part of the Array API standard then a description of similar style should be added to the same file.
The following modifications should be made to the description:
- [ ] ❌: Remove type definitions in the `Parameters` and `Returns` sections.
- [ ] ❌: Add `out` to the `Parameters` section if function accepts an `out` argument.
- [ ] ❌: Replace `out` with `ret` in the `Returns` section.
2. - [ ] ❌: Reference to docstring for ivy.function_name ([5.a](#ref1)) for the function description **and** modified `Parameters` and `Returns` sections as described in [the docs](https://unify.ai/docs/ivy/overview/deep_dive/docstrings.html#docstrings) in:
2. - [ ] ❌: Reference to docstring for ivy.function_name ([5.a](#ref1)) for the function description **and** modified `Parameters` and `Returns` sections as described in [the docs](https://docs.ivy.dev/overview/deep_dive/docstrings.html#docstrings) in:
- [ ] ❌: [ivy/array/{{ .category_name }}.py](https://github.com/unifyai/ivy/blob/main/ivy/data_classes/array/{{ .category_name }}.py).
- [ ] ❌: [ivy/container/{{ .category_name }}.py](https://github.com/unifyai/ivy/blob/main/ivy/data_classes/container/{{ .category_name }}.py) (in the static and instance method versions).
- [ ] ❌: [ivy/array/array.py](https://github.com/unifyai/ivy/blob/main/ivy/data_classes/array/array.py) if the function has a special method ( like `__function_name__` ).
- [ ] ❌: [ivy/array/array.py](https://github.com/unifyai/ivy/blob/main/ivy/data_classes/array/array.py) if the function has a reverse special method ( like `__rfunction_name__` ).
- [ ] ❌: [ivy/container/container.py](https://github.com/unifyai/ivy/blob/main/ivy/data_classes/container/container.py) if the function has a special method ( like `__function_name__` ).
- [ ] ❌: [ivy/container/container.py](https://github.com/unifyai/ivy/blob/main/ivy/data_classes/container/container.py) if the function has a reverse special method ( like `__rfunction_name__` ).
6. - [ ] ❌: Add thorough [Docstring Examples](https://unify.ai/docs/ivy/overview/deep_dive/docstring_examples.html#docstring-examples) for every function **and** its _relevant methods_ and ensure they pass the docstring tests.
6. - [ ] ❌: Add thorough [Docstring Examples](https://docs.ivy.dev/overview/deep_dive/docstring_examples.html#docstring-examples) for every function **and** its _relevant methods_ and ensure they pass the docstring tests.

**Functional Examples** in [ivy/functional/{{ .category_name }}.py](https://github.com/unifyai/ivy/blob/main/ivy/functional/ivy/{{ .category_name }}.py).

Expand Down
2 changes: 1 addition & 1 deletion docs/overview/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The contributor guide is split into the sections below, it's best to go from sta
contributing/setting_up.rst
contributing/the_basics.rst
contributing/building_the_docs.rst
Deep Dive <https://unify.ai/docs/ivy/overview/deep_dive.html>
Deep Dive <https://docs.ivy.dev/overview/deep_dive.html>
contributing/open_tasks.rst
contributing/contributor_rewards.rst
contributing/helpful_resources.rst
Expand Down
2 changes: 1 addition & 1 deletion docs/overview/deep_dive/ivy_frontends.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Ivy Frontends
Introduction
------------

On top of the Ivy functional API and backend functional APIs, Ivy has another set of framework-specific frontend functional APIs, which play an important role in code transpilations, as explained `here <https://lets-unify.ai/docs/ivy/overview/design/ivy_as_a_transpiler.html>`_.
On top of the Ivy functional API and backend functional APIs, Ivy has another set of framework-specific frontend functional APIs, which play an important role in code transpilations, as explained `here <https://docs.ivy.dev/overview/design/ivy_as_a_transpiler.html>`_.



Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ def _strip(line):
long_description_content_type="text/markdown",
url="https://ivy.dev",
project_urls={
"Docs": "https://ivy.dev/docs/",
"Docs": "https://docs.ivy.dev/",
"Source": "https://github.com/ivy-llc/ivy",
},
include_package_data=True,
Expand Down

0 comments on commit ba8a081

Please sign in to comment.