Deploy docs

.github/workflows/documentation.yml

@@ -18,13 +18,11 @@ jobs:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2
         with:
-          julia-version: 'nightly'
+          version: 'nightly'
       - uses: julia-actions/cache@v1
       - name: Install dependencies
         run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
       - name: Build and deploy
-        with:
-          julia-version: 'nightly'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key

README.md

@@ -2,7 +2,7 @@
 
 [![Latest Release](https://img.shields.io/github/release/BioJulia/MemViews.jl.svg)](https://github.com/BioJulia/MemViews.jl/releases/latest)
 [![MIT license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/BioJulia/MemViews.jl/blob/master/LICENSE)
-[![Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://biojulia.github.io/MemViews.jl/stable)
+[![Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://biojulia.github.io/MemViews.jl/latest)
 
 This package implements `MemView`, a simple, low-level view into a chunk of `Memory`, as well as the `MemKind` trait to guide dispatch of generic methods to memory views.
 It is intended to be used as a foundational base for other packages.
@@ -59,6 +59,9 @@ foo(x::AbstractString) = foo(codeunits(x))
 * Slicing a memory view produces a memory view - it does not copy.
 
 ## Limitations
+* Many optimised fast methods for more established types like `Vector` are missing for `MemView`.
+  These are added over time. Please make an issue or a PR as you encounter missing methods.
+
 * Currently, `MemView` does not make use of `Core.GenericMemory`'s additional parameters, such as atomicity or address space.
   This may easily be added with a `GenericMemView` type, similar to `Memory` / `GenericMemory`.
 

docs/make.jl

@@ -14,3 +14,10 @@ makedocs(;
     checkdocs=:public,
     remotes=nothing,
 )
+
+deploydocs(
+    repo = "github.com/BioJulia/MemViews.jl.git",
+    push_preview = true,
+    deps = nothing,
+    make = nothing,
+)