Skip to content

Commit c890602

Browse files
committed
Implement issues 1, 3, 4, 5, and 6
- Improve NodeJS installation instructions with NVM recommendations (Issue #1) - Redesign homepage with MyCoder-specific content (Issue #3) - Use short titles for blog posts in navigation panel (Issue #4) - Enhance author profiles with additional social links (Issue #5) - Link DriveCore, Inc. in the footer to https://drivecore.ai (Issue #6)
1 parent 87c5e44 commit c890602

File tree

11 files changed

+222
-30
lines changed

11 files changed

+222
-30
lines changed

blog/agentic-coding-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Best Practices for Efficient Agentic Coding
3-
subTitle: Agentic Coding Best Practices
3+
shortTitle: Agentic Coding Best Practices
44
date: 2025-03-06
55
authors: [ben]
66
tags: [ai, coding]

blog/authors.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,15 @@ ben:
55
image_url: https://github.com/bhouston.png
66
socials:
77
github: bhouston
8-
twitter: BenHouston3D
8+
x: BenHouston3D # Updated from twitter
9+
bluesky: benhouston.bsky.social
10+
mastodon: '@[email protected]'
911

1012
mycoder_team:
1113
name: MyCoder Team
1214
title: MyCoder Development Team
1315
url: https://github.com/drivecore
1416
image_url: https://github.com/drivecore.png
17+
socials:
18+
github: drivecore
19+
x: mycoderAI

docs/getting-started/linux.md

Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,43 @@ This guide will help you set up MyCoder on Linux.
99
## Prerequisites
1010

1111
1. **Node.js**: Install Node.js version 20.0.0 or higher
12-
- Using package manager (Ubuntu/Debian):
13-
```bash
14-
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
15-
sudo apt-get install -y nodejs
16-
```
17-
- Using package manager (Fedora/RHEL):
18-
```bash
19-
curl -fsSL https://rpm.nodesource.com/setup_20.x | sudo bash -
20-
sudo yum install -y nodejs
21-
```
22-
- Verify installation with `node --version`
12+
13+
> **⚠️ Important:** MyCoder requires Node.js runtime to function properly.
14+
15+
**Recommended: Using NVM (Node Version Manager)**
16+
17+
NVM is the preferred way to install Node.js as it allows for easy version management and avoids permission issues:
18+
19+
```bash
20+
# Install NVM
21+
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
22+
23+
# Reload shell configuration
24+
source ~/.bashrc # or source ~/.zshrc
25+
26+
# Install latest LTS version of Node.js
27+
nvm install --lts
28+
29+
# Set it as default
30+
nvm use --lts
31+
32+
# Verify installation
33+
node --version
34+
```
35+
36+
**Alternative: Using package manager (Ubuntu/Debian):**
37+
```bash
38+
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
39+
sudo apt-get install -y nodejs
40+
```
41+
42+
**Alternative: Using package manager (Fedora/RHEL):**
43+
```bash
44+
curl -fsSL https://rpm.nodesource.com/setup_20.x | sudo bash -
45+
sudo yum install -y nodejs
46+
```
47+
48+
Verify installation with `node --version`
2349

2450
2. **Git**: Install Git if not already available
2551
- Ubuntu/Debian: `sudo apt-get install git`

docs/getting-started/macos.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,39 @@ This guide will help you set up MyCoder on macOS.
99
## Prerequisites
1010

1111
1. **Node.js**: Install Node.js version 20.0.0 or higher
12-
- Using Homebrew: `brew install node`
13-
- Or download from [nodejs.org](https://nodejs.org/)
14-
- Verify installation with `node --version`
12+
13+
> **⚠️ Important:** MyCoder requires Node.js runtime to function properly.
14+
15+
**Recommended: Using NVM (Node Version Manager)**
16+
17+
NVM is the preferred way to install Node.js as it allows for easy version management and avoids permission issues:
18+
19+
```bash
20+
# Install NVM
21+
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
22+
23+
# Reload shell configuration
24+
source ~/.zshrc # or source ~/.bash_profile for older macOS versions
25+
26+
# Install latest LTS version of Node.js
27+
nvm install --lts
28+
29+
# Set it as default
30+
nvm use --lts
31+
32+
# Verify installation
33+
node --version
34+
```
35+
36+
**Alternative: Using Homebrew:**
37+
```bash
38+
brew install node
39+
```
40+
41+
**Alternative: Direct download**
42+
Download from [nodejs.org](https://nodejs.org/)
43+
44+
Verify installation with `node --version`
1545

1646
2. **Git**: macOS typically comes with Git pre-installed
1747
- Verify with `git --version`

docs/getting-started/windows.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,31 @@ This guide will help you set up MyCoder on Windows.
99
## Prerequisites
1010

1111
1. **Node.js**: Install Node.js version 20.0.0 or higher
12+
13+
> **⚠️ Important:** MyCoder requires Node.js runtime to function properly.
14+
15+
**Recommended: Using NVM for Windows (Node Version Manager)**
16+
17+
NVM for Windows is the preferred way to install Node.js as it allows for easy version management:
18+
19+
```
20+
# Download and install NVM for Windows
21+
# Visit: https://github.com/coreybutler/nvm-windows/releases
22+
# Download the nvm-setup.exe file from the latest release
23+
24+
# After installation, open a new Command Prompt and install Node.js
25+
nvm install lts
26+
27+
# Set it as default
28+
nvm use lts
29+
30+
# Verify installation
31+
node --version
32+
```
33+
34+
**Alternative: Direct download**
1235
- Download from [nodejs.org](https://nodejs.org/)
36+
- Run the installer and follow the prompts
1337
- Verify installation with `node --version`
1438

1539
2. **Git**: Install Git for Windows

docusaurus.config.ts

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,21 @@ const config: Config = {
5656
onInlineTags: 'warn',
5757
onInlineAuthors: 'warn',
5858
onUntruncatedBlogPosts: 'warn',
59+
// Use short titles in blog sidebar
60+
blogSidebarTitle: 'Recent Posts',
61+
blogSidebarCount: 10,
62+
blogTitle: 'MyCoder Blog',
63+
postsPerPage: 5,
64+
blogListComponent: '@theme/BlogListPage',
65+
blogPostComponent: '@theme/BlogPostPage',
66+
blogTagsListComponent: '@theme/BlogTagsListPage',
67+
blogTagsPostsComponent: '@theme/BlogTagsPostsPage',
68+
rehypePlugins: [],
69+
beforeDefaultRemarkPlugins: [],
70+
beforeDefaultRehypePlugins: [],
71+
truncateMarker: /<!-- truncate -->/,
72+
// Add custom transform function to use shortTitle if available
73+
blogSidebarItemComponent: require.resolve('./src/components/BlogSidebarItem'),
5974
},
6075
theme: {
6176
customCss: './src/css/custom.css',
@@ -122,7 +137,7 @@ const config: Config = {
122137
href: 'https://discord.gg/5K6TYrHGHt',
123138
},
124139
{
125-
label: 'Twitter',
140+
label: 'X (Twitter)',
126141
href: 'https://twitter.com/mycoderAI',
127142
},
128143
],
@@ -145,7 +160,7 @@ const config: Config = {
145160
],
146161
},
147162
],
148-
copyright: `Copyright © ${new Date().getFullYear()} DriveCore, Inc. Built with Docusaurus.`,
163+
copyright: `Copyright © ${new Date().getFullYear()} <a href="https://drivecore.ai">DriveCore, Inc.</a> Built with Docusaurus.`,
149164
},
150165
prism: {
151166
theme: prismThemes.github,
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import React from 'react';
2+
import Link from '@docusaurus/Link';
3+
import styles from './styles.module.css';
4+
5+
export default function BlogSidebarItem({permalink, title, shortTitle}) {
6+
// Use shortTitle if available, otherwise use title
7+
const displayTitle = shortTitle || title;
8+
9+
return (
10+
<Link to={permalink} className={styles.sidebarItemLink}>
11+
{displayTitle}
12+
</Link>
13+
);
14+
}
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.sidebarItemLink {
2+
display: block;
3+
margin-bottom: 0.8rem;
4+
color: var(--ifm-color-primary);
5+
text-decoration: none;
6+
}
7+
8+
.sidebarItemLink:hover {
9+
text-decoration: underline;
10+
}

src/components/HomepageFeatures/index.tsx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,32 +11,32 @@ type FeatureItem = {
1111

1212
const FeatureList: FeatureItem[] = [
1313
{
14-
title: 'Easy to Use',
14+
title: 'AI-Powered Coding Assistant',
1515
Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
1616
description: (
1717
<>
18-
Docusaurus was designed from the ground up to be easily installed and
19-
used to get your website up and running quickly.
18+
MyCoder leverages advanced AI models to understand your requirements
19+
and generate high-quality code solutions in multiple programming languages.
2020
</>
2121
),
2222
},
2323
{
24-
title: 'Focus on What Matters',
24+
title: 'Context-Aware Responses',
2525
Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default,
2626
description: (
2727
<>
28-
Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
29-
ahead and move your docs into the <code>docs</code> directory.
28+
MyCoder understands your project structure and existing code, providing
29+
solutions that integrate seamlessly with your codebase.
3030
</>
3131
),
3232
},
3333
{
34-
title: 'Powered by React',
34+
title: 'Built for Developers',
3535
Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
3636
description: (
3737
<>
38-
Extend or customize your website layout by reusing React. Docusaurus can
39-
be extended while reusing the same header and footer.
38+
Designed with developer workflows in mind, MyCoder integrates with your
39+
terminal, code editor, and development environment.
4040
</>
4141
),
4242
},

src/pages/index.module.css

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,34 @@
2121
align-items: center;
2222
justify-content: center;
2323
}
24+
25+
.quickStart {
26+
padding: 3rem 0;
27+
background-color: var(--ifm-color-emphasis-100);
28+
}
29+
30+
.codeBlock {
31+
background-color: var(--ifm-color-emphasis-200);
32+
border-radius: 8px;
33+
padding: 1rem;
34+
overflow: auto;
35+
}
36+
37+
.docsLinks {
38+
list-style-type: none;
39+
padding-left: 0;
40+
}
41+
42+
.docsLinks li {
43+
margin-bottom: 1rem;
44+
font-size: 1.1rem;
45+
}
46+
47+
.docsLinks a {
48+
color: var(--ifm-color-primary);
49+
text-decoration: none;
50+
}
51+
52+
.docsLinks a:hover {
53+
text-decoration: underline;
54+
}

src/pages/index.tsx

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,60 @@ function HomepageHeader() {
2121
<Link
2222
className="button button--secondary button--lg"
2323
to="/docs/intro">
24-
Docusaurus Tutorial - 5min ⏱️
24+
Get Started with MyCoder
2525
</Link>
2626
</div>
2727
</div>
2828
</header>
2929
);
3030
}
3131

32+
function HomepageQuickStart() {
33+
return (
34+
<section className={styles.quickStart}>
35+
<div className="container">
36+
<div className="row">
37+
<div className="col col--6">
38+
<Heading as="h2">Quick Start</Heading>
39+
<p>
40+
Get up and running with MyCoder in minutes. MyCoder is an AI-powered coding assistant
41+
that helps you write better code faster.
42+
</p>
43+
<pre className={styles.codeBlock}>
44+
<code>
45+
# Install MyCoder globally<br />
46+
npm install -g mycoder<br /><br />
47+
# Use MyCoder with a prompt<br />
48+
mycoder "Create a React component that displays a counter"
49+
</code>
50+
</pre>
51+
</div>
52+
<div className="col col--6">
53+
<Heading as="h2">Popular Documentation</Heading>
54+
<ul className={styles.docsLinks}>
55+
<li><Link to="/docs/getting-started/windows">Windows Setup</Link></li>
56+
<li><Link to="/docs/getting-started/macos">macOS Setup</Link></li>
57+
<li><Link to="/docs/getting-started/linux">Linux Setup</Link></li>
58+
<li><Link to="/docs/usage">Usage Guide</Link></li>
59+
<li><Link to="/blog">Latest Updates</Link></li>
60+
</ul>
61+
</div>
62+
</div>
63+
</div>
64+
</section>
65+
);
66+
}
67+
3268
export default function Home(): ReactNode {
3369
const {siteConfig} = useDocusaurusContext();
3470
return (
3571
<Layout
36-
title={`Hello from ${siteConfig.title}`}
37-
description="Description will go into a meta tag in <head />">
72+
title={`${siteConfig.title} - AI-Powered Coding Assistant`}
73+
description="MyCoder is an AI-powered coding assistant that helps developers write better code faster with context-aware code generation.">
3874
<HomepageHeader />
3975
<main>
4076
<HomepageFeatures />
77+
<HomepageQuickStart />
4178
</main>
4279
</Layout>
4380
);

0 commit comments

Comments
 (0)