Contribute to Documentation

Contributing with examples can be done by first creating a new file example here

new file

• your_new_file.md at docs/src/UserGuide/

Once this is done you need to add a new entry here at the appropriate level.

add entry to docs

Your new entry should look like:

• { text: 'Your title example', link: '/UserGuide/your_new_file.md' }

Build docs locally

If you want to take a look at the docs locally before doing a PR follow the next steps:

Install the dependencies in your system, locate yourself at the docs level folder, then do

npm i

Then simply go to your docs env and activate it, i.e.

docs> julia
julia> ]
pkg> activate .

Next, run the scripts. Generate files and build docs by running:

include("make.jl")

Now go to your terminal in the same path docs> and run:

npm run docs:dev

This should ouput http://localhost:5173/YAXArrays.jl/, copy/paste this into your browser and you are all set.