Merge pull request #1710 from bettio/switch-to-new-doc-domain-sources

Link doc.atomvm.org in source files and some markdown files

These changes are made under both the "Apache 2.0" and the "GNU Lesser General
Public License 2.1 or later" license terms (dual license).

SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later

Author: bettio

CONTRIBUTING.md

@@ -169,7 +169,7 @@ C source modules (`.c`) should be organized as follows:
 
 #### Documentation
 
-[Doxygen Javadoc style](https://www.doxygen.nl/manual/docblocks.html) code comments will be picked up and added to the documentation. Changes will automatically be added to the [libAtomVM Source Files](https://www.atomvm.net/doc/main/c_api_docs.html#libatomvm-source-files) and the [libAtomVM Index](https://www.atomvm.net/doc/main/apidocs/libatomvm/index.html#libatomvm-index). But to have `Data Structures`, `Types`, `MACROS`, and `Functions` appear in the correct C Library APIs section the corresponding entries must be added to the similarly named `*.rst` files in the `AtomVM/doc/src/apidocs/libatomvm/` directory. The exact names of the files that need to be altered are: `data_structures.rst`, `functions.rst`, `macros.rst`, and `types.rst`. The other files in the directory handle auto`generated content and do not need to be altered.
+[Doxygen Javadoc style](https://www.doxygen.nl/manual/docblocks.html) code comments will be picked up and added to the documentation. Changes will automatically be added to the [libAtomVM Source Files](https://doc.atomvm.org/release-0.6/apidocs/libatomvm/index.html#libatomvm-source-files) and the [libAtomVM Index](https://doc.atomvm.org/release-0.6/apidocs/libatomvm/index.html#libatomvm-index). But to have `Data Structures`, `Types`, `MACROS`, and `Functions` appear in the correct C Library APIs section the corresponding entries must be added to the similarly named `*.rst` files in the `AtomVM/doc/src/apidocs/libatomvm/` directory. The exact names of the files that need to be altered are: `data_structures.rst`, `functions.rst`, `macros.rst`, and `types.rst`. The other files in the directory handle auto`generated content and do not need to be altered.
 
 In the rare case that a function declaration and definition are both in different header files (rather than the definition in a `*.c` file) this can cause rendering errors for `Doxygen`. The work around for these cases can be demonstrated with this example for the function `sys_listener_destroy` it is documented and declared in `sys.h` and defined as follows in `listeners.h`:
 

README.Md

@@ -15,21 +15,21 @@ AtomVM implements from scratch a minimal Erlang VM that supports a subset of Erl
 Supported Platforms
 ===================
 
-* Linux, macOS, FreeBSD, DragonFly ([generic_unix](https://www.atomvm.net/doc/main/getting-started-guide.html#getting-started-on-the-generic-unix-platform))
-* ESP32 SoC (with IDF/FreeRTOS, see [esp32](https://www.atomvm.net/doc/main/getting-started-guide.html#getting-started-on-the-esp32-platform))
-* STM32 MCUs (with LibOpenCM3, see [stm32](https://www.atomvm.net/doc/main/getting-started-guide.html#getting-started-on-the-stm32-platform))
-* Raspberry Pi Pico (see [rp2040](https://www.atomvm.net/doc/main/getting-started-guide.html#getting-started-on-the-raspberry-pi-pico-platform))
-* Browsers and NodeJS with WebAssembly (see [emscripten](https://www.atomvm.net/doc/main/getting-started-guide.html#getting-started-with-atomvm-webassembly))
+* Linux, macOS, FreeBSD, DragonFly ([generic_unix](https://doc.atomvm.org/release-0.6/getting-started-guide.html#getting-started-on-the-generic-unix-platform))
+* ESP32 SoC (with IDF/FreeRTOS, see [esp32](https://doc.atomvm.org/release-0.6/getting-started-guide.html#getting-started-on-the-esp32-platform))
+* STM32 MCUs (with LibOpenCM3, see [stm32](https://doc.atomvm.org/release-0.6/getting-started-guide.html#getting-started-on-the-stm32-platform))
+* Raspberry Pi Pico (see [rp2040](https://doc.atomvm.org/release-0.6/getting-started-guide.html#getting-started-on-the-raspberry-pi-pico-platform))
+* Browsers and NodeJS with WebAssembly (see [emscripten](https://doc.atomvm.org/release-0.6/getting-started-guide.html#getting-started-with-atomvm-webassembly))
 
 AtomVM aims to be easily portable to new platforms with a minimum effort, so additional platforms
 might be supported in a near future.
 
 Getting Started
 ===============
 There is much more information, including a more complete
-["Getting Started Guide"](https://www.atomvm.net/doc/main/getting-started-guide.html),
+["Getting Started Guide"](https://doc.atomvm.org/release-0.6/getting-started-guide.html),
 [examples](https://www.atomvm.net/sample-code),
-detailed [build instructions](https://www.atomvm.net/doc/main/build-instructions.html),
+detailed [build instructions](https://doc.atomvm.org/release-0.6/build-instructions.html),
 and [contact information](https://www.atomvm.net/contact) available on the
 [AtomVM](https://atomvm.net) project website.
 
@@ -73,14 +73,14 @@ $ ./src/AtomVM ./tests/libs/eavmlib/test_eavmlib.avm
 $ ./src/AtomVM ./tests/libs/alisp/test_alisp.avm
 ```
 
-Complete [Build Instructions](https://www.atomvm.net/doc/main/build-instructions.html) are
+Complete [Build Instructions](https://doc.atomvm.org/release-0.6/build-instructions.html) are
 available in the documentation for
-[Generic UNIX](https://www.atomvm.net/doc/main/build-instructions.html) (Linux, MacOS, FreeBSD, DragonFly),
-[ESP32](https://www.atomvm.net/doc/main/build-instructions.html#building-for-esp32),
-[STM32](https://www.atomvm.net/doc/main/build-instructions.html#building-for-stm32),
-[Raspberry Pi Pico](https://www.atomvm.net/doc/main/build-instructions.html#building-for-raspberry-pi-pico)
+[Generic UNIX](https://doc.atomvm.org/release-0.6/build-instructions.html) (Linux, MacOS, FreeBSD, DragonFly),
+[ESP32](https://doc.atomvm.org/release-0.6/build-instructions.html#building-for-esp32),
+[STM32](https://doc.atomvm.org/release-0.6/build-instructions.html#building-for-stm32),
+[Raspberry Pi Pico](https://doc.atomvm.org/release-0.6/build-instructions.html#building-for-raspberry-pi-pico)
 (rp2040), and
-[WASM](https://www.atomvm.net/doc/main/build-instructions.html#building-for-nodejs-web) (NodeJS/Web).
+[WASM](https://doc.atomvm.org/release-0.6/build-instructions.html#building-for-nodejs-web) (NodeJS/Web).
 
 Project Status
 ==============

src/platforms/esp32/test/README.md

@@ -10,7 +10,7 @@ AtomVM provides two paths for testing "on device", the locally run QEMU emulator
 
 # QEMU emulator testing
 
-Instructions for running the tests [on QEMU are documented here](https://www.atomvm.net/doc/main/build-instructions.html#running-tests-for-esp32).
+Instructions for running the tests [on QEMU are documented here](https://doc.atomvm.org/release-0.6/build-instructions.html#running-tests-for-esp32).
 
 # Wokwi CI simulator testing
 

src/platforms/esp32/tools/CMakeLists.txt

@@ -64,5 +64,5 @@ file(COPY ${CMAKE_BINARY_DIR}/${CMAKE_FILES_DIRECTORY}/flash.sh
 
 if (NOT EXISTS ../../../../build/libs/esp32boot/esp32boot.avm)
     message(WARNING "A generic_unix build must be done first in the top level AtomVM/build directory! \n\
-    Consult https://www.atomvm.net/doc/main/build-instructions.html for build instructions.")
+    Consult https://doc.atomvm.org/release-0.6/build-instructions.html for build instructions.")
 endif()

tools/test/smoke-test/README.md

@@ -151,7 +151,7 @@ Your ESP32 device is now flashed with the ESP32 image you specified.
 
 The [`atomvm_examples`](https://github.com/atomvm/atomvm_examples) repo is a good place to start smoke testing.  We assume you know how to clone this repo using git.
 
-Note that you will need a supported OTP version and at least a recent version of the [rebar3](https://rebar3.org) tool.  If you want to smoke test Elixir programs, you should also have a comaptible version of the Elixir compiler and runtime available.  Consult the AtomVM [Relaase Notes](https://www.atomvm.net/doc/main/release-notes.html) for compatibility information.
+Note that you will need a supported OTP version and at least a recent version of the [rebar3](https://rebar3.org) tool.  If you want to smoke test Elixir programs, you should also have a comaptible version of the Elixir compiler and runtime available.  Consult the AtomVM [Relaase Notes](https://doc.atomvm.org/release-0.6/release-notes.html) for compatibility information.
 
 To run an example program, `cd` into the appropriate example directory, and build and flash the program.  We will show an example with the [`hello_world`](https://github.com/atomvm/atomvm_examples/tree/master/erlang/hello_world) program.