Merge pull request #116 from amd-jnovotny/hipfft-metadata-readme-rel63

Cherry-pick to release-staging/rocm-rel-6.3: Add note to read me with metadata and NVIDIA changes
ROCm · Oct 15, 2024 · 85a2d27 · 85a2d27
2 parents 42e0528 + a4001df
commit 85a2d27
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -10,8 +10,8 @@ and marshals results back to your application.
 
 ## Documentation
 
-Documentation for hipFFT is available at
-[https://rocm.docs.amd.com/projects/hipFFT/en/latest/](https://rocm.docs.amd.com/projects/hipFFT/en/latest/).
+> [!NOTE]
+> The published hipFFT documentation is available at [hipFFT](https://rocm.docs.amd.com/projects/hipFFT/en/latest/index.html) in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in the hipFFT/docs folder of this repository. As with all ROCm projects, the documentation is open source. For more information, see [Contribute to ROCm documentation](https://rocm.docs.amd.com/en/latest/contribute/contributing.html).
 
 To build our documentation locally, run the following code:
 

diff --git a/docs/api.rst b/docs/api.rst
@@ -9,7 +9,7 @@ hipFFT API Usage
 ********************************************************************
 
 This section describes usage of the hipFFT library API.  The hipFFT
-API follows the `cuFFT`_ API.
+API follows the NVIDIA `cuFFT`_ API.
 
 .. _cuFFT: https://docs.nvidia.com/cuda/cufft/
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -8,7 +8,7 @@
 hipFFT documentation
 ********************************************************************
 
-Welcome to the hipFFT documentation home page. hipFFT is an FFT marshalling library. Currently, hipFFT supports either rocFFT_ or cuFFT_ as the backend, as explained in :ref:`hipfft-overview`.
+Welcome to the hipFFT documentation home page. hipFFT is an FFT marshalling library. Currently, hipFFT supports either rocFFT_ or NVIDIA cuFFT_ as the backend, as explained in :ref:`hipfft-overview`.
 
 .. _rocFFT: https://rocm.docs.amd.com/projects/rocFFT/en/latest/index.html
 .. _cuFFT: https://developer.nvidia.com/cufft

diff --git a/docs/license.md b/docs/license.md
@@ -1,3 +1,10 @@
+---
+myst:
+    html_meta:
+        "description": "hipFFT licensing information"
+        "keywords": "hipFFT, FFT, ROCm, API, documentation, license"
+---
+
 # License
 
 ```{include} ../LICENSE.md

diff --git a/docs/overview.rst b/docs/overview.rst
@@ -9,7 +9,7 @@ hipFFT Overview
 ********************************************************************
 
 hipFFT is a GPU FFT marshalling library that supports
-either `rocFFT`_ or `cuFFT`_ as the backend.
+either `rocFFT`_ or NVIDIA `cuFFT`_ as the backend.
 
 hipFFT exports an interface that does not require the client to
 change, regardless of the chosen backend.  It sits between the