Skip to content

Commit

Permalink
Docs: all the links were broken. These are not great docs, but better…
Browse files Browse the repository at this point in the history
… than showing 404. We will fix the docs later.
  • Loading branch information
avikalpg committed Oct 8, 2024
1 parent e530934 commit 394e9fe
Show file tree
Hide file tree
Showing 5 changed files with 141 additions and 5 deletions.
34 changes: 34 additions & 0 deletions pages/docs/contributor-guide/dpu-setup.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import React from 'react'
import Navbar from '../../../views/Navbar';
import Footer from '../../../components/Footer';
import DocsSideBar from '../../../views/docs/DocsSideBar';
import { RenderMarkdown } from '../../../components/RenderMarkdown';


const Terms = () => {
const [contributorGuideContent, setContributorGuideContent] = React.useState('');

React.useEffect(() => {
fetch('https://raw.githubusercontent.com/vibinex/vibi-dpu/refs/heads/main/README.md')
.then(response => response.text())
.then(text => setContributorGuideContent(text))
.catch(error => console.error('Error fetching CONTRIBUTING.md:', error));
}, []);

return (
<>
<Navbar transparent={false} />
<div className="flex flex-col sm:flex-row">
<DocsSideBar className='w-full sm:w-80' />

<div className='sm:w-2/3 mx-auto mt-8 px-2 py-2'>
<RenderMarkdown markdownText={contributorGuideContent} />
</div>

</div>
<Footer />
</>
)
}

export default Terms
34 changes: 34 additions & 0 deletions pages/docs/contributor-guide/extension-setup.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import React from 'react'
import Navbar from '../../../views/Navbar';
import Footer from '../../../components/Footer';
import DocsSideBar from '../../../views/docs/DocsSideBar';
import { RenderMarkdown } from '../../../components/RenderMarkdown';


const Terms = () => {
const [contributorGuideContent, setContributorGuideContent] = React.useState('');

React.useEffect(() => {
fetch('https://raw.githubusercontent.com/vibinex/chrome-extension/refs/heads/main/README.md')
.then(response => response.text())
.then(text => setContributorGuideContent(text))
.catch(error => console.error('Error fetching CONTRIBUTING.md:', error));
}, []);

return (
<>
<Navbar transparent={false} />
<div className="flex flex-col sm:flex-row">
<DocsSideBar className='w-full sm:w-80' />

<div className='sm:w-2/3 mx-auto mt-8 px-2 py-2'>
<RenderMarkdown markdownText={contributorGuideContent} />
</div>

</div>
<Footer />
</>
)
}

export default Terms
34 changes: 34 additions & 0 deletions pages/docs/contributor-guide/index.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import React from 'react'
import Navbar from '../../../views/Navbar';
import Footer from '../../../components/Footer';
import DocsSideBar from '../../../views/docs/DocsSideBar';
import { RenderMarkdown } from '../../../components/RenderMarkdown';


const Terms = () => {
const [contributorGuideContent, setContributorGuideContent] = React.useState('');

React.useEffect(() => {
fetch('https://raw.githubusercontent.com/vibinex/vibinex/refs/heads/main/CONTRIBUTING.md')
.then(response => response.text())
.then(text => setContributorGuideContent(text))
.catch(error => console.error('Error fetching CONTRIBUTING.md:', error));
}, []);

return (
<>
<Navbar transparent={false} />
<div className="flex flex-col sm:flex-row">
<DocsSideBar className='w-full sm:w-80' />

<div className='sm:w-2/3 mx-auto mt-8 px-2 py-2'>
<RenderMarkdown markdownText={contributorGuideContent} />
</div>

</div>
<Footer />
</>
)
}

export default Terms
34 changes: 34 additions & 0 deletions pages/docs/contributor-guide/server-setup.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import React from 'react'
import Navbar from '../../../views/Navbar';
import Footer from '../../../components/Footer';
import DocsSideBar from '../../../views/docs/DocsSideBar';
import { RenderMarkdown } from '../../../components/RenderMarkdown';


const Terms = () => {
const [contributorGuideContent, setContributorGuideContent] = React.useState('');

React.useEffect(() => {
fetch('https://raw.githubusercontent.com/vibinex/vibinex-server/refs/heads/main/README.md')
.then(response => response.text())
.then(text => setContributorGuideContent(text))
.catch(error => console.error('Error fetching CONTRIBUTING.md:', error));
}, []);

return (
<>
<Navbar transparent={false} />
<div className="flex flex-col sm:flex-row">
<DocsSideBar className='w-full sm:w-80' />

<div className='sm:w-2/3 mx-auto mt-8 px-2 py-2'>
<RenderMarkdown markdownText={contributorGuideContent} />
</div>

</div>
<Footer />
</>
)
}

export default Terms
10 changes: 5 additions & 5 deletions views/docs/DocsSideBar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ const navItems: SidebarNavItem[] = [
],
},
{
label: 'Developer Guide',
label: 'Contributor Guide',
href: '',
children: [
{ label: 'Overview', href: '/docs/developer-guide' },
{ label: 'Environment Setup', href: '/docs/developer-guide/environment-setup' },
{ label: 'Code Overview', href: '/docs/developer-guide/code-overview' },
{ label: 'Contribution Guide', href: '/docs/developer-guide/contribution-guide' },
{ label: 'Overview', href: '/docs/contributor-guide' },
{ label: 'Server Setup', href: '/docs/contributor-guide/server-setup' },
{ label: 'Modifying the browser extension', href: '/docs/contributor-guide/extension-setup' },
{ label: 'Environment Setup for DPU', href: '/docs/contributor-guide/dpu-setup' },
// Add more developer-specific items here
],
},
Expand Down

0 comments on commit 394e9fe

Please sign in to comment.