|
1 | | -# Tezos Documentation Portal (Beta) |
| 1 | +# MOVED: Tezos developer documentation |
2 | 2 |
|
3 | | -This is the source code for the Tezos Documentation Portal: https://docs.tezos.com |
4 | | - |
5 | | -## Contributing |
6 | | - |
7 | | -We welcome contributions to the documentation! Here's how you can get involved: |
8 | | - |
9 | | -1. Fork the repository: Click the "Fork" button at the top-right corner of this page to create your own copy of the repository. |
10 | | - |
11 | | -2. Clone your fork: Clone the repository to your local machine using `git clone https://github.com/<your-username>/<repository>.git`. |
12 | | - |
13 | | -3. Create a branch: Create a new branch with a descriptive name for your changes, e.g., `git checkout -b my-feature`. |
14 | | - |
15 | | -4. Make changes: Implement your changes, enhancements, or bug fixes on your branch. |
16 | | - |
17 | | -5. Commit your changes: Add and commit your changes using `git add .` and `git commit -m "Your commit message"`. |
18 | | - |
19 | | -6. Push your changes: Push your changes to your fork using `git push origin my-feature`. |
20 | | - |
21 | | -7. Create a pull request: Navigate to the original repository on GitHub and click the "New Pull Request" button. Select your fork and branch, then click "Create Pull Request". |
22 | | - |
23 | | -## Getting started |
24 | | - |
25 | | -To setup the site locally, first install the npm dependencies: |
26 | | - |
27 | | -```bash |
28 | | -npm install |
29 | | -cp .env.example .env.local |
30 | | -``` |
31 | | - |
32 | | -Next, run the development server: |
33 | | - |
34 | | -```bash |
35 | | -npm run start |
36 | | -``` |
37 | | - |
38 | | -Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website. |
39 | | - |
40 | | -## Tests |
41 | | - |
42 | | -The workflow `.github/workflows/tests.yml` runs automated tests on pull requests. |
43 | | -To run tests locally, run `npm run test -- --filesToCheck=docs/developing.md,docs/architecture.mdx`, where `--filesToCheck` is a comma-separated list of the MD and MDX files to test. |
44 | | - |
45 | | -Docusaurus automatically checks for broken links and markdown-encoded images when you run `npm run build`. |
46 | | - |
47 | | -## Dependencies |
48 | | - |
49 | | -MD and MDX files have fields that show the versions of tools that they were tested on, as in this example: |
50 | | - |
51 | | -```markdown |
52 | | ---- |
53 | | -title: My topic |
54 | | -dependencies: |
55 | | - smartpy: 0.19.0 |
56 | | - ligo: 1.6.0 |
57 | | - archetype: 1.0.26 |
58 | | ---- |
59 | | -``` |
60 | | - |
61 | | -The current versions of these tools are set in the file `src/scripts/dependencies.json`. |
62 | | -When you run `npm run check-dependencies`, a script checks for files that need to be updated. |
63 | | - |
64 | | -- You can check specific tools by passing them to the script, as in `npm run check-dependencies -- --dependencies=smartpy,taquito`. |
65 | | -- By default, the script checks for differences down to the fixpack level, but you can pass `--major` or `--minor` to check for differences at those levels. |
66 | | -- By default, it checks all files, but you can pass individual files or folders to check after the other arguments, as in `npm run check-dependencies -- --major -d=smartpy,taquito docs/developing/octez-client/accounts.md docs/tutorials/build-your-first-app.md` or `npm run check-dependencies -- --major -d=smartpy,taquito docs/tutorials`. |
67 | | - |
68 | | -## Search |
69 | | - |
70 | | -Search on the site is powered by Algolia Docsearch. |
71 | | -The index is in the [Algolia dashboard](https://dashboard.algolia.com/apps/QRIAHGML9Q/dashboard). |
72 | | -Contextual search is enabled according to the [Docusaurus instructions](https://docusaurus.io/docs/search#using-algolia-docsearch), although the site does not currently use contextual search to separate searches by version, language, or other similar factors. |
73 | | - |
74 | | -The search uses [this crawler](https://crawler.algolia.com/admin/crawlers/eaa2c548-8b82-493b-8ab8-0c37e2e5d5cc/configuration/edit) to index the site: |
75 | | - |
76 | | -```js |
77 | | -new Crawler({ |
78 | | - rateLimit: 8, |
79 | | - maxDepth: 10, |
80 | | - maxUrls: 5000, |
81 | | - startUrls: ["https://docs.tezos.com/"], |
82 | | - sitemaps: ["https://docs.tezos.com/sitemap.xml"], |
83 | | - renderJavaScript: false, |
84 | | - ignoreCanonicalTo: true, |
85 | | - ignoreQueryParams: ["source", "utm_*"], |
86 | | - discoveryPatterns: ["https://docs.tezos.com/**"], |
87 | | - schedule: "every 24 hours", |
88 | | - appId: "QRIAHGML9Q", |
89 | | - apiKey: "API_KEY_GOES_HERE", |
90 | | - actions: [ |
91 | | - { |
92 | | - indexName: "tezosdocs", |
93 | | - pathsToMatch: ["https://docs.tezos.com/**"], |
94 | | - recordExtractor: ({ $, helpers }) => { |
95 | | - // priority order: deepest active sub list header -> navbar active item -> 'Documentation' |
96 | | - const lvl0 = |
97 | | - $( |
98 | | - ".menu__link.menu__link--sublist.menu__link--active, .navbar__item.navbar__link--active", |
99 | | - ) |
100 | | - .last() |
101 | | - .text() || "Documentation"; |
102 | | - |
103 | | - return helpers.docsearch({ |
104 | | - recordProps: { |
105 | | - lvl0: { |
106 | | - selectors: "", |
107 | | - defaultValue: lvl0, |
108 | | - }, |
109 | | - lvl1: ["header h1", "article h1"], |
110 | | - lvl2: "article h2", |
111 | | - lvl3: "article h3", |
112 | | - lvl4: "article h4", |
113 | | - lvl5: "article h5, article td:first-child", |
114 | | - lvl6: "article h6", |
115 | | - content: "article p, article li, article td:last-child", |
116 | | - }, |
117 | | - indexHeadings: true, |
118 | | - aggregateContent: true, |
119 | | - recordVersion: "v3", |
120 | | - }); |
121 | | - }, |
122 | | - }, |
123 | | - ], |
124 | | - initialIndexSettings: { |
125 | | - tezosdocs: { |
126 | | - attributesForFaceting: [ |
127 | | - "type", |
128 | | - "lang", |
129 | | - "language", |
130 | | - "version", |
131 | | - "docusaurus_tag", |
132 | | - ], |
133 | | - attributesToRetrieve: [ |
134 | | - "hierarchy", |
135 | | - "content", |
136 | | - "anchor", |
137 | | - "url", |
138 | | - "url_without_anchor", |
139 | | - "type", |
140 | | - ], |
141 | | - attributesToHighlight: ["hierarchy", "content"], |
142 | | - attributesToSnippet: ["content:10"], |
143 | | - camelCaseAttributes: ["hierarchy", "content"], |
144 | | - searchableAttributes: [ |
145 | | - "unordered(hierarchy.lvl0)", |
146 | | - "unordered(hierarchy.lvl1)", |
147 | | - "unordered(hierarchy.lvl2)", |
148 | | - "unordered(hierarchy.lvl3)", |
149 | | - "unordered(hierarchy.lvl4)", |
150 | | - "unordered(hierarchy.lvl5)", |
151 | | - "unordered(hierarchy.lvl6)", |
152 | | - "content", |
153 | | - ], |
154 | | - distinct: true, |
155 | | - attributeForDistinct: "url", |
156 | | - customRanking: [ |
157 | | - "desc(weight.pageRank)", |
158 | | - "desc(weight.level)", |
159 | | - "asc(weight.position)", |
160 | | - ], |
161 | | - ranking: [ |
162 | | - "words", |
163 | | - "filters", |
164 | | - "typo", |
165 | | - "attribute", |
166 | | - "proximity", |
167 | | - "exact", |
168 | | - "custom", |
169 | | - ], |
170 | | - highlightPreTag: '<span class="algolia-docsearch-suggestion--highlight">', |
171 | | - highlightPostTag: "</span>", |
172 | | - minWordSizefor1Typo: 3, |
173 | | - minWordSizefor2Typos: 7, |
174 | | - allowTyposOnNumericTokens: false, |
175 | | - minProximity: 1, |
176 | | - ignorePlurals: true, |
177 | | - advancedSyntax: true, |
178 | | - attributeCriteriaComputedByMinProximity: true, |
179 | | - removeWordsIfNoResults: "allOptional", |
180 | | - separatorsToIndex: "_", |
181 | | - }, |
182 | | - }, |
183 | | -}); |
184 | | -``` |
185 | | - |
186 | | -## License |
187 | | - |
188 | | -This project is open for contribution but the source code itself uses a commercial template and is therefore not licensed under any open-source license. Forking this project as a base for your own projects is not permitted under the license of the original template. |
| 3 | +The source code for this documentation has been moved to https://gitlab.com/tezos/docs. |
0 commit comments