Skip to content

docs: comprehensive documentation and sitemap updates#73

Closed
cosmic-flood wants to merge 5 commits into
mainfrom
docs/update-eec6686
Closed

docs: comprehensive documentation and sitemap updates#73
cosmic-flood wants to merge 5 commits into
mainfrom
docs/update-eec6686

Conversation

@cosmic-flood
Copy link
Copy Markdown
Contributor

Includes documentation updates and sitemap changes from local commits.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 21, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
featbit-docs Ready Ready Preview, Comment May 21, 2026 12:34pm

@cosmic-flood
Copy link
Copy Markdown
Contributor Author

@copilot review this pull request

Copy link
Copy Markdown
Contributor

Copilot AI commented May 21, 2026

@copilot review this pull request

Here's my review of this PR:

Slack → Discord migration
All community/support Slack links have been correctly updated to Discord (https://discord.gg/ytK9xGJSw3) across data-export.mdx, rbac.md, setup-license-key.mdx, sdk/overview.md, and theme.config.tsx. The remaining Slack references in integrations/chat-apps/slack.mdx and webhooks.mdx are about the Slack product integration feature (not community links) and are correctly left unchanged.

public/sitemap.xml
Covers 79 public pages, matching the actual pages/ directory structure. All URLs look accurate.
⚠️ Minor: This is a static file that will need manual updates when pages are added/removed. Consider using next-sitemap to auto-generate at build time.

public/llms.txt
Well-structured and follows the emerging llms.txt standard for LLM discoverability. Content is accurate and well-organized.

public/robots.txt ⚠️
The LLMS: https://docs.featbit.co/llms.txt line is non-standard — robots.txt does not define an LLMS: directive. Standard parsers will silently ignore unknown directives, so this is harmless, but worth removing for correctness. The llms.txt file is discoverable simply by being hosted at /llms.txt.

next.config.js — HSTS header
Adding Strict-Transport-Security: max-age=31536000; includeSubDomains; preload is a good security practice for an HTTPS-only docs site. Note that the preload flag is a strong commitment (difficult to undo); make sure the site is or will be registered in the HSTS preload list.

next-env.d.ts ⚠️
The removed line (/// <reference types="next/navigation-types/compat/navigation" />) is from a Next.js auto-generated file that includes the comment "NOTE: This file should not be edited". This change may be intentional if the Next.js version was updated, but could be reverted on the next build. It's worth verifying this is correct for the current Next.js version.

Summary: The core changes (Discord migration, sitemap, llms.txt, HSTS) are solid. The non-standard LLMS: directive in robots.txt and the next-env.d.ts edit are minor concerns worth addressing.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds SEO and crawler-facing assets for the FeatBit docs site (sitemap/robots/llms) and updates Next.js config to emit an HSTS header.

Changes:

  • Added public/sitemap.xml with a full set of docs URLs and lastmod timestamps.
  • Added public/robots.txt and public/llms.txt to advertise sitemap and LLM-friendly entry points.
  • Updated next.config.js to send the Strict-Transport-Security header; removed an unused TS reference from next-env.d.ts.

Reviewed changes

Copilot reviewed 3 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
public/sitemap.xml Introduces a static sitemap for docs URLs and last-modified metadata.
public/robots.txt Allows crawling and points crawlers to sitemap (and llms.txt).
public/llms.txt Provides an LLM-oriented index of key documentation and related repos.
next.config.js Configures global response headers to include HSTS.
next-env.d.ts Removes the next/navigation-types compat reference.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread public/robots.txt
Allow: /

Sitemap: https://docs.featbit.co/sitemap.xml
LLMS: https://docs.featbit.co/llms.txt
Comment thread public/sitemap.xml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants