Skip to content

Commit 0f2a088

Browse files
spivxspivx
committed
feat: enhance README and layout for improved clarity and SEO; add robots and sitemap functionality
1 parent 473a7b4 commit 0f2a088

File tree

10 files changed

+250
-94
lines changed

10 files changed

+250
-94
lines changed

‎README.md‎

Lines changed: 35 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,47 @@
11
![devcontext logo](public/logo.png)
22

3-
## Generate the perfect context file for your development workflow**
4-
5-
A tool that helps developers create optimized context files based on their IDE, framework, and coding conventions.
6-
7-
---
8-
9-
## What is devcontext?
10-
11-
devcontext helps you generate customized context files that work perfectly with your development setup. Whether you're using VS Code with React, IntelliJ with Spring Boot, or any other combination, devcontext creates context files tailored to your specific environment and preferences.
12-
13-
## How it works
14-
15-
1. **Select your IDE** - VS Code, IntelliJ, Vim, Sublime Text, etc.
16-
2. **Choose your framework** - React, Vue, Angular, Spring, Django, etc.
17-
3. **Set your preferences** - Coding style, file structure, naming conventions
18-
4. **Generate context** - Get a perfectly tailored context file for your workflow
19-
20-
## Why use devcontext?
21-
22-
- **Better AI assistance** - Context files optimized for your specific setup improve AI code suggestions
23-
- **Faster onboarding** - New team members get the right context immediately
24-
- **Consistent workflow** - Standardize context across your team and projects
25-
- **Time-saving** - No more manually creating context files for each project
26-
27-
## Getting Started
28-
29-
Visit [https://www.devcontext.xyz/](https://www.devcontext.xyz/) to start generating your context files.
30-
31-
### For Developers
32-
33-
If you want to contribute to the project or run it locally:
34-
3+
# devcontext
4+
5+
Build high-signal agent and instruction files from community-proven best practices.
6+
7+
## What devcontext does
8+
- Transforms curated community knowledge into ready-to-use instructions for agents, coding copilots, and repo guides.
9+
- Guides you through a multi-step wizard that selects files, frameworks, and scenario-specific topics.
10+
- Surfaces examples, trade-offs, and documentation links so every choice is backed by trusted references.
11+
12+
## How the wizard works
13+
1. Launch the app and switch from the landing hero to the Instructions Wizard.
14+
2. Pick the instruction file you want to assemble (from templates defined in `data/files.json`).
15+
3. Choose your framework and automatically load its follow-up question set (dynamic imports from `data/questions/<framework>.json`).
16+
4. Answer or skip topic prompts across general, architecture, performance, security, commits, and more.
17+
5. Review a completion summary that highlights which best practices made it into your file and which were skipped for later.
18+
19+
## Community knowledge base
20+
- Every topic originates from the developer community—playbooks, real-world retrospectives, and shared tooling habits.
21+
- JSON entries in `data/` capture those insights: each answer carries labels, examples, pros/cons, tags, and authoritative `docs` links.
22+
- Disabled options mark ideas that the community is still refining; they stay visible so contributors can track demand.
23+
- Icon choices use Simple Icons with automatic contrast adjustments for readability across themes.
24+
25+
## Key interaction details
26+
- Tooltips open from the info icon, letting you explore examples, pros/cons, tags, and external docs without losing your place.
27+
- Multi-select questions support skipping (recorded as `null`) so uncertain topics never block progress.
28+
- Progress indicators keep a running count of answered versus skipped items, making gaps obvious before export.
29+
30+
## Run devcontext locally
3531
```bash
3632
git clone https://github.com/spivx/devcontext.git
3733
cd devcontext
3834
npm install
3935
npm run dev
4036
```
37+
Then open the printed local URL in your browser to explore the wizard.
4138

42-
## Contributing
39+
## Contribute back to the community
40+
- Add or improve topics in `data/*.json` with clear labels, examples, and `docs` links.
41+
- Propose new framework questionnaires under `data/questions/`, keeping the schema consistent.
42+
- Share hooks, utilities, or UI refinements that make the wizard easier to reason about for first-time contributors.
4343

44-
Help us improve devcontext by:
45-
- Adding support for new IDEs and frameworks
46-
- Improving context file templates
47-
- Reporting bugs or suggesting features
44+
Every addition helps the community build better instruction files faster.
4845

4946
## License
50-
51-
MIT License - see [LICENSE](LICENSE) for details.
47+
MIT License — see [`LICENSE`](LICENSE) for the full text.

‎app/layout.tsx‎

Lines changed: 101 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import type { Metadata } from "next";
22
import { Suspense } from "react";
3+
import Script from "next/script";
34
import { Geist, Geist_Mono } from "next/font/google";
45
import "./globals.css";
56
import { ThemeProvider } from "@/components/theme-provider";
@@ -16,47 +17,128 @@ const geistMono = Geist_Mono({
1617
subsets: ["latin"],
1718
});
1819

19-
export const metadata: Metadata = {
20-
title: "DevContext – AI Coding Guidelines & Context Generator",
21-
description:
22-
"DevContext helps developers generate AI config files like Copilot instructions, Cursor rules, and prompts — consistent, fast, IDE-ready.",
20+
const siteUrl = "https://devcontext.com";
21+
const siteTitle = "DevContext – AI Coding Guidelines & Context Generator";
22+
const siteDescription =
23+
"DevContext helps developers generate AI config files like Copilot instructions, Cursor rules, and prompts — consistent, fast, IDE-ready.";
24+
25+
const ogImage = `${siteUrl}/og-image.png`;
2326

24-
// Open Graph (Facebook, LinkedIn, etc.)
27+
const structuredData = {
28+
"@context": "https://schema.org",
29+
"@type": "SoftwareApplication",
30+
name: "DevContext",
31+
applicationCategory: "DeveloperApplication",
32+
operatingSystem: "Web",
33+
url: siteUrl,
34+
image: ogImage,
35+
description: siteDescription,
36+
author: {
37+
"@type": "Organization",
38+
name: "DevContext",
39+
url: siteUrl,
40+
},
41+
offers: {
42+
"@type": "Offer",
43+
price: 0,
44+
priceCurrency: "USD",
45+
},
46+
featureList: [
47+
"Guided wizard for AI coding instructions",
48+
"Prebuilt templates for Copilot, Cursor, and IDE agents",
49+
"Context-aware questions with best-practice examples",
50+
],
51+
keywords: [
52+
"generate Copilot instructions file",
53+
"generate agents file",
54+
"generate AI instructions",
55+
"generate Cursor rules",
56+
"AI development workflows",
57+
],
58+
};
59+
60+
export const metadata: Metadata = {
61+
metadataBase: new URL(siteUrl),
62+
title: {
63+
default: siteTitle,
64+
template: `%s | DevContext`,
65+
},
66+
applicationName: "DevContext",
67+
description: siteDescription,
68+
keywords: [
69+
"AI coding guidelines",
70+
"AI prompt templates",
71+
"Copilot instructions generator",
72+
"Cursor rules builder",
73+
"IDE setup automation",
74+
"Developer onboarding docs",
75+
"generate Copilot instructions file",
76+
"generate agents file",
77+
"generate instructions",
78+
"generate Cursor rule",
79+
"Copilot instructions",
80+
"Cursor rules",
81+
"agents md",
82+
],
83+
authors: [{ name: "DevContext" }],
84+
creator: "DevContext",
85+
publisher: "DevContext",
86+
category: "Technology",
87+
alternates: {
88+
canonical: siteUrl,
89+
},
2590
openGraph: {
26-
title: "DevContext – AI Coding Guidelines & Context Generator",
91+
title: siteTitle,
2792
description:
2893
"Generate AI config files like Copilot instructions, Cursor rules, and prompts. Consistent, fast, and IDE-ready.",
29-
url: "https://devcontext.com",
94+
url: siteUrl,
3095
siteName: "DevContext",
3196
images: [
3297
{
33-
url: "/og-image.png", // put a 1200x630 PNG in /public
98+
url: ogImage,
3499
width: 1200,
35100
height: 630,
36-
alt: "DevContext Logo",
101+
alt: "DevContext marketing preview",
37102
},
38103
],
39104
locale: "en_US",
40105
type: "website",
41106
},
42-
43-
// Twitter card
44107
twitter: {
45108
card: "summary_large_image",
46-
title: "DevContext – AI Coding Guidelines & Context Generator",
109+
title: siteTitle,
47110
description:
48111
"Generate AI config files like Copilot instructions, Cursor rules, and prompts. Consistent, fast, and IDE-ready.",
49-
images: ["/og-image.png"], // reuse the same OG image
50-
creator: "@yourtwitterhandle", // optional
112+
images: [ogImage],
113+
site: "@devcontext",
114+
},
115+
robots: {
116+
index: true,
117+
follow: true,
118+
googleBot: {
119+
index: true,
120+
follow: true,
121+
"max-video-preview": -1,
122+
"max-image-preview": "large",
123+
"max-snippet": -1,
124+
},
51125
},
52-
53-
// Favicon and theme color (optional but good for branding)
54126
icons: {
55127
icon: "/favicon.ico",
56128
shortcut: "/favicon.ico",
57129
apple: "/apple-touch-icon.png",
58130
},
131+
manifest: "/site.webmanifest",
59132
themeColor: "#09090b",
133+
other: {
134+
"msapplication-TileColor": "#09090b",
135+
},
136+
referrer: "origin-when-cross-origin",
137+
formatDetection: {
138+
email: false,
139+
address: false,
140+
telephone: false,
141+
},
60142
};
61143

62144

@@ -72,6 +154,9 @@ export default function RootLayout({
72154
<body
73155
className={`${geistSans.variable} ${geistMono.variable} antialiased`}
74156
>
157+
<Script id="structured-data" type="application/ld+json" strategy="beforeInteractive">
158+
{JSON.stringify(structuredData)}
159+
</Script>
75160
<ThemeProvider
76161
attribute="class"
77162
defaultTheme="dark"

‎app/page.tsx‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,17 @@ export default function Home() {
6060
<Logo />
6161

6262
{/* Headline */}
63-
<h2 className="max-w-4xl text-3xl font-bold">
64-
AI Coding Instructions, Backed by Real Developer Experience
65-
</h2>
63+
<h1 className="max-w-4xl text-3xl font-bold">
64+
Assemble Tailored AI Coding Playbooks With a Guided Wizard
65+
</h1>
6666

6767
{/* Subheadline */}
6868
<p className="max-w-xl text-lg leading-relaxed text-muted-foreground">
69-
Turn developer best practices into ready-to-use AI instructions.
69+
Move from curated best practices to sharable files like Copilot instructions, Cursor rules, and agents.md playbooks in just a few guided steps.
70+
</p>
71+
72+
<p className="max-w-xl text-sm text-muted-foreground/80">
73+
Use the wizard to generate Copilot instruction files, agents files, comprehensive instruction sets, and Cursor rules without starting from a blank page.
7074
</p>
7175

7276
{/* File type CTAs */}

‎app/robots.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import type { MetadataRoute } from "next";
2+
3+
const baseUrl = "https://devcontext.com";
4+
5+
export default function robots(): MetadataRoute.Robots {
6+
return {
7+
rules: {
8+
userAgent: "*",
9+
allow: "/",
10+
},
11+
host: baseUrl,
12+
sitemap: `${baseUrl}/sitemap.xml`,
13+
};
14+
}

‎app/sitemap.ts‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import type { MetadataRoute } from "next";
2+
3+
const baseUrl = "https://devcontext.com";
4+
5+
export default function sitemap(): MetadataRoute.Sitemap {
6+
const lastModified = new Date();
7+
8+
return [
9+
{
10+
url: baseUrl,
11+
lastModified,
12+
changeFrequency: "weekly",
13+
priority: 1,
14+
},
15+
];
16+
}

0 commit comments

Comments
 (0)