Merge pull request #7 from Kitware/dev/docs

bjrichardwebster · web-flow · commit 2f8adc5c0d18 · 2025-11-24T15:50:32.000-05:00
Added offline documentation
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -15,6 +15,9 @@ repos:
     rev: v5.0.0
     hooks:
       - id: check-added-large-files
+        args:
+          # the unit here is acutally KiB (1024 bytes)
+          - '--maxkb=51200'  # match github max of 50MiB
       - id: check-ast
       - id: check-builtin-literals
       - id: check-case-conflict
diff --git a/README.md b/README.md
@@ -59,10 +59,9 @@ transformed_image = transformed["image"]
 
 ## Documentation
 
-For detailed documentation on available transforms and usage patterns, see:
+Albumentations documentation is [hosted by the original authors](https://albumentations.ai/docs/). An [offline copy](./docs/albumentations-documentation.pdf) of the documentation has been included with this repository, with the expectation that the hosted documentation may eventually become unavailable or diverge from the forked functionality. This offline copy was generated from [this commit hash](https://github.com/albumentations-team/albumentations-ai-docs/tree/624837ded1550ab528f5b77e4f91d37cf7982a27). Note that some external files and links may not be functional.
 
-- [Albumentations (NRTK Fork) Documentation](https://nrtk-albumentations.readthedocs.io/)
-- [NRTK Documentation](https://nrtk.readthedocs.io/)
+For usage within the NRTK ecosystem, please refer to [NRTK Documentation](https://nrtk.readthedocs.io/).
 
 ## Available Transformations
 
diff --git a/docs/albumentations-documentation.pdf b/docs/albumentations-documentation.pdf
diff --git a/docs/release_notes/pending_release.rst b/docs/release_notes/pending_release.rst
@@ -10,6 +10,10 @@ Updates / New Features
 
 * Removed OpenCV dependency. The package will no longer be able to be used standalone.
 
+* Added offline copy of forked documentation
+
+* Updated precommit check for large files to be consistent with NRTK
+
 Fixes
 -----
 
