Repository navigation

Improve documentation - #41

Merged

GamelinAl merged 70 commits into

mainfrom

docs/intro-structure-configuration

Oct 7, 2026

Commits on Sep 23, 2026

docs: introduce pyAML, its structure and the configuration rule

GamelinAl
and
claude
committed
4d5d9b7
Edit
GamelinAl
committed
5e458d3
Edit 2
GamelinAl
committed
518565e

Commits on Sep 24, 2026

Separate glossary
GamelinAl
committed
a27c994
Made the link to what is pyAML more visible by adding a tip.
TeresiaOlsson
committed
1522d34
Updated the description of pyAML to include that it is more than a single library.
TeresiaOlsson
committed
a81249a
Updated why a middle layer part to better explain what a middle layer is an focus the list on features that are new in pyAML.
TeresiaOlsson
committed
a2d92ff
Remove space.
TeresiaOlsson
committed
1feac74
Add that the test lattice is also used for integration tests.
TeresiaOlsson
committed
069e6f2
Change that all measurements behave in the same way to similar way.
TeresiaOlsson
committed
69042be
Merge pull request #44 from python-accelerator-middle-layer/docs/pyaml-structure
TeresiaOlsson
authored
545f263
Merge pull request #43 from python-accelerator-middle-layer/docs/what-is-pyaml
TeresiaOlsson
authored
8e1120d
Merge pull request #45 from python-accelerator-middle-layer/docs/control-modes
TeresiaOlsson
authored
e928326
Mark pyAT as a name as for other names.
TeresiaOlsson
committed
1db6e25
Added a tip to highlight that using the dynamic catalog is the recommended option.
TeresiaOlsson
committed
79efc5d
Merge pull request #46 from python-accelerator-middle-layer/docs/glossary
GamelinAl
authored
f541530
List classes for static catalog in tango-pyaml as a list.
TeresiaOlsson
committed
8a31ec6
Specify that each field is the name of the field in the constructor and the value to be passed.
TeresiaOlsson
committed
8ac91ca
Remove the grid since it required scrolling to be able to see both sets of codes at the same time.
TeresiaOlsson
committed
d230d26
Removed unknown fields are rejected since this is only true if validation is turned on and not a general requirement for the configuration.
TeresiaOlsson
committed
f80e3b6
Changed link for API documentation to the page with links for all packages and not only pyaml.
TeresiaOlsson
committed
fda240a
Add JSON schema and link to tools to list of option to find fields.
TeresiaOlsson
committed
60194c2
Updated info and config examples for the dynamic catalog.
TeresiaOlsson
committed
9d1b0bb
Move glossary to main menu.
TeresiaOlsson
committed
d118c89
Remove section about finding the fields to move it to the how-to guide instead.
TeresiaOlsson
committed
375f908
Merge info in configuration item into previous section.
TeresiaOlsson
committed
a1cc723
Remove glossary from explanations index.
TeresiaOlsson
committed
8387d09
Add tip to read the explanation page before starting.
TeresiaOlsson
committed
61a03e8
Add some more details to the introduction.
TeresiaOlsson
committed
210ba64
Remove in the introduction that the guide is about text file since it also includes dictionary.
TeresiaOlsson
committed
4064839
Update the rule to remember section to make it clearer how using a configuration differs from building objects yourself.
TeresiaOlsson
committed
f4197be
Update finding the fields section with content from moved from the configuration explanation.
TeresiaOlsson
committed
39485af
Add that the configuration can be written as yaml, json or dict.
TeresiaOlsson
committed
9616c0b
Change heading to make clear that the example is for using a text file since the dictionary option also exist.
TeresiaOlsson
committed
33db49d
Update the facility and machine name.
TeresiaOlsson
committed
bfd9280

Commits on Sep 25, 2026

Commits on Oct 2, 2026

Commits on Oct 5, 2026

Commits on Oct 6, 2026

Add a new tool pages
GamelinAl
committed
15b65b7
Add back the test lattice text in the tutorial
GamelinAl
committed
00ad2eb
Merge pull request #52 from python-accelerator-middle-layer/docs/create-accelerator
GamelinAl
authored
3a934c5

Commits

Commits on Sep 23, 2026

Commits on Sep 24, 2026

Commits on Sep 25, 2026

Commits on Oct 2, 2026

Commits on Oct 5, 2026

Commits on Oct 6, 2026

Commits on Oct 7, 2026