llms.txt introduction (#2967)

* add file generator and template for common content

* add chain specific data

* add chain specific data for stability, shibarium, scroll and zilliqa

* fix ts

* add instructions about contract sources

Author: tom2drum

.gitignore

@@ -22,6 +22,7 @@
 /public/static/og_image.png
 /public/sitemap.xml
 /public/robots.txt
+/public/llms.txt
 /analyze
 
 # production

Dockerfile

@@ -51,6 +51,12 @@ WORKDIR /multichain-config-generator
 COPY ./deploy/tools/multichain-config-generator/package.json ./deploy/tools/multichain-config-generator/yarn.lock ./
 RUN yarn --frozen-lockfile --network-timeout 100000
 
+### llms.txt GENERATOR
+# Install dependencies
+WORKDIR /llms-txt-generator
+COPY ./deploy/tools/llms-txt-generator/package.json ./deploy/tools/llms-txt-generator/yarn.lock ./
+RUN yarn --frozen-lockfile --network-timeout 100000
+
 
 # *****************************
 # ****** STAGE 2: Build *******
@@ -117,6 +123,11 @@ COPY --from=deps /sitemap-generator/node_modules ./deploy/tools/sitemap-generato
 COPY --from=deps /multichain-config-generator/node_modules ./deploy/tools/multichain-config-generator/node_modules
 RUN cd ./deploy/tools/multichain-config-generator && yarn build
 
+### llms.txt GENERATOR
+# Copy dependencies and source code, then build 
+COPY --from=deps /llms-txt-generator/node_modules ./deploy/tools/llms-txt-generator/node_modules
+RUN cd ./deploy/tools/llms-txt-generator && yarn build
+
 
 # *****************************
 # ******* STAGE 3: Run ********
@@ -146,9 +157,10 @@ COPY --from=builder /app/package.json ./package.json
 COPY --from=builder /app/deploy/tools/envs-validator/index.js ./envs-validator.js
 COPY --from=builder /app/deploy/tools/feature-reporter/index.js ./feature-reporter.js
 COPY --from=builder /app/deploy/tools/multichain-config-generator/dist ./deploy/tools/multichain-config-generator/dist
+COPY --from=builder /app/deploy/tools/llms-txt-generator/dist ./deploy/tools/llms-txt-generator/dist
 
 # Copy scripts
-## Entripoint
+## Entrypoint
 COPY --chmod=755 ./deploy/scripts/entrypoint.sh .
 ## ENV validator and client script maker
 COPY --chmod=755 ./deploy/scripts/validate_envs.sh .

deploy/scripts/entrypoint.sh

@@ -70,6 +70,9 @@ node ./deploy/tools/multichain-config-generator/dist/index.js
 # Generate sitemap.xml and robots.txt files
 ./sitemap_generator.sh
 
+# Generate llms.txt file
+node ./deploy/tools/llms-txt-generator/dist/index.js
+
 # Print list of enabled features
 node ./feature-reporter.js
 

deploy/tools/llms-txt-generator/.gitignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+*.log
+.DS_Store