Skip to content

Commit da2cf55

Browse files
committed
.github/llm: Add imported from guidelines
Explain that imported pages should contain the imported from marker. Signed-off-by: Jorge Marques <[email protected]>
1 parent c9ae091 commit da2cf55

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

.github/workflows/llm.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,11 +104,32 @@ jobs:
104104
adoc serve --sparse docs/learning docs/solutions/reference-designs/ad4052-ardz
105105
```
106106
It is more efficient than calling sphinx-build and building all pages.
107+
107108
This documentation is currently being imported from dokuwiki.
108109
You can fetch dokuwiki pages by suffixing `?do=export_raw`, for example
109110
https://wiki.analog.com/resources/fpga/docs/axi_dmac?do=export_raw
110111
You can match dokuwiki pagen names with `<query>?do=search`, for example
111112
https://wiki.analog.com/ad9081?do=search
113+
Or you can use `adoc search-wiki`:
114+
```
115+
$ adoc search-wiki CN0359
116+
Searching wiki.analog.com for: CN0359
117+
118+
[0] CN0359 Conductivity Measurement System User Guide
119+
https://wiki.analog.com/resources/eval/user-guides/circuits-from-the-lab/cn0359
120+
$ adoc search-wiki --fetch 0 --format raw
121+
Fetching: CN0359 Conductivity Measurement System User Guide
122+
URL: https://wiki.analog.com/resources/eval/user-guides/circuits-from-the-lab/cn0359
123+
---
124+
====== CN0359 Conductivity Measurement System User Guide ======
125+
...
126+
```
127+
Imported pages should container the marker as the first line:
128+
```
129+
.. imported from: https://wiki.analog.com/path/to/page
130+
131+
.. rest of the content
132+
```
112133
113134
## Task 1: Content check
114135
At this task, you will focus on the content, fixing content logical

0 commit comments

Comments
 (0)