Skip to content

Commit 9838f17

Browse files
committed
remove outdated troubleshooting guide, fix review comments
1 parent d94c335 commit 9838f17

File tree

6 files changed

+8
-43
lines changed

6 files changed

+8
-43
lines changed

.github/workflows/build_docs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ on:
44
push:
55
branches:
66
- master # Triggers deployment on push to the main branch
7-
- 405-move-readme-content-to-documentation
87

98
env:
109
UV_SYSTEM_PYTHON: true

docs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ A series of tutorials giving you an overview on how to store or convert your dat
2727

2828
- [Converting your data to NeXus](tutorial/converting-data-to-nexus.md)
2929
- [Uploading NeXus data to NOMAD](tutorial/nexus-to-nomad.md)
30-
- [Troubleshooting guide](tutorial/troubleshooting.md)
3130

3231
</div>
3332
<div markdown="block">
@@ -72,6 +71,8 @@ How-to guides provide step-by-step instructions for a wide range of tasks.
7271
Or go directly to the [official NIAC](https://manual.nexusformat.org/classes/index.html)
7372
or [latest FAIRmat](https://fairmat-nfdi.github.io/nexus_definitions/) definitions.
7473

74+
Note: To connect NeXus concepts with semantic web tools, efforts are underway to represent them using the [W3C Web Ontology Language (OWL)](https://www.w3.org/OWL/). See the [NeXusOntology](https://github.com/FAIRmat-NFDI/NeXusOntology) for more details.
75+
7576
#### pynxtools
7677

7778
`pynxtools` has a number of command line tools that can be used to convert data and verify NeXus files. You can find more information about the API [here](reference/cli-api.md).

docs/learn/nexus-validation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ One of the main advantages of using pynxtools is that it comes with its own vali
77
During [data conversion](./dataconverter-and-readers.md), before writing the HDF5 file, the data is first checked against the provided application definition.
88

99
<!--## verify-nexus: Testing existing NeXus/HDF5 files
10-
This CLI tool can be used to validate _existing_ HDF5 files that claim to be NeXus-compliant. See [here](reference/cli-api.html#verify-nexus) for the API documentation.-->
10+
This CLI tool can be used to validate _existing_ HDF5 files that claim to be NeXus-compliant. See [here](reference/cli-api.md#verify-nexus) for the API documentation.-->
1111

1212
## read_nexus: NeXus file reader and debugger
1313

14-
This utility outputs a debug log for a given NeXus file by annotating the data and metadata entries with the schema definitions from the respective NeXus base classes and application definitions to which the file refers to. See [here](../reference/cli-api.html#read_nexus) for the API documentation.
14+
This utility outputs a debug log for a given NeXus file by annotating the data and metadata entries with the schema definitions from the respective NeXus base classes and application definitions to which the file refers to. See [here](../reference/cli-api.md#read_nexus) for the API documentation.
1515

1616
The following example dataset can be used to test the `read_nexus` module: [src/pynxtools/data/201805_WSe2_arpes.nxs](https://github.com/FAIRmat-NFDI/pynxtools/blob/master/src/pynxtools/data/201805_WSe2_arpes.nxs).
1717

docs/reference/definitions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,7 @@ The FAIRmat definitions are regularly contributed to NIAC (around every 6 months
1010
a state which is still under development and may contain new or improved application definitions or base classes.
1111
Consider it as the public review stage of these application definitions.
1212
However, there might be some parts which are still under discussion and will be subject to change.
13+
14+
Note: To connect NeXus concepts with semantic web tools, efforts are underway to represent them using the [W3C Web Ontology Language (OWL)](https://www.w3.org/OWL/). See the [NeXusOntology](https://github.com/FAIRmat-NFDI/NeXusOntology) for more details.
15+
16+

docs/tutorial/troubleshooting.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

mkdocs.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ nav:
1010
- Tutorials:
1111
- tutorial/converting-data-to-nexus.md
1212
- tutorial/nexus-to-nomad.md
13-
- tutorial/troubleshooting.md
1413
- How-tos:
1514
- how-tos/writing-an-appdef.md
1615
- how-tos/using-multiple-appdefs.md

0 commit comments

Comments
 (0)