Merge pull request #55 from shinybrar/54-bug-fix-documentation-links

fix(docs): updated doc/status/badge links

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to Skaha
 
-Thank you for considering contributing to the Skaha project! We welcome contributions from everyone. Please follow the guidelines below to help us maintain a high-quality codebase. 
+Thank you for considering contributing to the Skaha project! We welcome contributions from everyone. Please follow the guidelines below to help us maintain a high-quality codebase.
 
 We follow the [Contributor Convenant of Code of Conduct](https://github.com/shinybrar/skaha/blob/main/CODE_OF_CONDUCT.md). If you wish to contribute to Skaha, please make sure to familiarize yourself with it.
 
@@ -53,7 +53,7 @@ Make your changes. Please make sure to add tests for your changes if applicable.
 
 ### 5. Run the Tests
 
-To run tests for Skaha, you need to have a valid CANFAR account and access to the CANFAR Science Platform. To generate a certificate, please refer to the [get started](docs/get-started.md) section.
+To run tests for Skaha, you need to have a valid CANFAR account and access to the CANFAR Science Platform. To generate a certificate, please refer to the [get started](get-started.md) section.
 
 ```bash
 uv run pytest

README.md

@@ -1,9 +1,11 @@
 # Skaha
-[![Continous Integration](https://github.com/CHIMEFRB/skaha/actions/workflows/ci.yml/badge.svg)](https://github.com/CHIMEFRB/skaha/actions/workflows/ci.yml)
-[![Continous Deployment](https://github.com/CHIMEFRB/skaha/actions/workflows/cd.yml/badge.svg)](https://github.com/CHIMEFRB/skaha/actions/workflows/cd.yml) [![docs](https://github.com/CHIMEFRB/skaha/actions/workflows/docs.yml/badge.svg)](https://github.com/CHIMEFRB/skaha/actions/workflows/docs.yml)
-[![CodeQL](https://github.com/CHIMEFRB/skaha/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/CHIMEFRB/skaha/actions/workflows/codeql-analysis.yml)
+[![Continous Integration](https://github.com/shinybrar/skaha/actions/workflows/ci.yml/badge.svg)](https://github.com/shinybrar/skaha/actions/workflows/ci.yml)
+[![Continous Deployment](https://github.com/shinybrar/skaha/actions/workflows/cd.yml/badge.svg)](https://github.com/shinybrar/skaha/actions/workflows/cd.yml)
+[![CodeQL](https://github.com/shinybrar/skaha/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/shinybrar/skaha/actions/workflows/codeql-analysis.yml)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/shinybrar/skaha/badge)](https://scorecard.dev/viewer/?uri=github.com/shinybrar/skaha)
 
-### For more information, check out the [Official Documentation](https://chimefrb.github.io/skaha/).
+
+### For more information, check out the [Official Documentation](https://shinybrar.github.io/skaha/).
 
 ---
 <p align="center">

docs/index.md

@@ -36,5 +36,5 @@
     ```
 
 [Get Started :material-coffee:](get-started.md){: .md-button .md-button--primary } 
-[Go to GitHub :fontawesome-brands-github:](https://github.com/chimefrb/skaha){: .md-button .md-button--primary }
+[Go to GitHub :fontawesome-brands-github:](https://github.com/shinybrar/skaha){: .md-button .md-button--primary }
 [Changelog :material-vector-polyline-remove:](changelog.md){: .md-button .md-button--primary }

mkdocs.yml

@@ -97,3 +97,4 @@ nav:
   - Contributing: contributing.md
   - Security: security.md
   - License: license.md
+  - OpenSSF Report: https://scorecard.dev/viewer/?uri=github.com/shinybrar/skaha

skaha/session.py

@@ -152,7 +152,7 @@ def logs(self, ids: Union[List[str], str]) -> Dict[str, str]:
         """Get logs from a session[s].
 
         Args:
-            id (Union[List[str], str]): Session ID[s].
+            ids (Union[List[str], str]): Session ID[s].
 
         Returns:
             Dict[str, str]: Logs in text/plain format.
@@ -269,7 +269,7 @@ def destroy(self, ids: Union[str, List[str]]) -> Dict[str, bool]:
         """Destroy skaha session[s].
 
         Args:
-            id (Union[str, List[str]]): Session ID[s].
+            ids (Union[str, List[str]]): Session ID[s].
 
         Returns:
             Dict[str, bool]: A dictionary of session IDs