Merge pull request #117 from bmad-sim/documentation

fixed URL issues
bmad-sim · Jan 6, 2025 · b42e82a · b42e82a
2 parents 8825088 + 1ed0dd1
commit b42e82a
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 # AtomicAndPhysicalConstants.jl
 
-`AtomicAndPhysicalConstants.jl` provides a quick way to access information about different species and physical constants.
+`AtomicAndPhysicalConstants.jl` provides a quick way to access information about different species and physical constants optimized for faster compile time and simulations.
 
 It is designed to provide atomic and physical constants including things like the speed of light, subatomic particle properties, atomic isotope properties, etc. 
 
@@ -33,7 +33,7 @@ julia> C_LIGHT
 2.99792458e8
 ```
 
-Users have the options for choosing the type and unit of the constants, see [this page](units.md)
+Users have the options for choosing the type and unit of the constants, see [this page](https://bmad-sim.github.io/AtomicAndPhysicalConstants.jl/dev/units/)
 
 ### Defining Species
 
@@ -53,4 +53,4 @@ julia> hydrogen.spin
 1.0 h_bar
 ```
 
-See more about `Species()` constructors and getter functions [here](species.md)
+See more about `Species()` constructors and getter functions [here](https://bmad-sim.github.io/AtomicAndPhysicalConstants.jl/dev/species/)
diff --git a/docs/src/species.md b/docs/src/species.md
@@ -53,7 +53,7 @@ Example:
 julia> Species("anti-proton")
 ```
 
-See the list of all available subatomic species [here](#list-of-available-subatomic-species)
+See the list of all available subatomic species at the end of this page.
 
 ### Constructing Atomic Species
 

diff --git a/docs/src/units.md b/docs/src/units.md
@@ -9,7 +9,7 @@ The user have the freedom to choose the unit they want for `mass`, `length`, `ti
 
 The users have the freedom to choose the version of CODATA they prefer.
 
-The users have the freedom to choose whether they want the constants to be of type `Float64` or Unitful types, which makes unit calculations easier. See more about `Unitful` [here](#unitful).
+The users have the freedom to choose whether they want the constants to be of type `Float64` or Unitful types, which makes unit calculations easier. 
 
 
 ### Syntax