migration to vocs #138
migration to vocs #138
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Great job Shiv! There will be two types of comments, PR related and not very related but I think we can fix things during this PR (broken links and similar). PR Related
There is no logo text and welcome text is not full. Documentation button feels redundant
Also, chatgpt default prompt doesnt work as I understand, so probably we need to remove chatgpt button for now (screeenshot above) 
It would be good to add texts near github icons 
Environment: some code blocks too large 
Recipes: we need to use line focus or line highlights in the examples similar to current docs. Currently, text in all the examples is not highlighted 
One more nit for recipes: order of the recipes is different from old docs 
Deploy smart contracts: do we need to highlight more these commands and similar ones in the page? 
Broken links etc
Also, this extension doesn't work with latest create-eth, so probably we need to change extension to example extension 
If you think it's better I can create another PR for second part of comments |
This one is working for me, maybe the browse feature has some regional restrictions? 
|
There was a problem hiding this comment.
typo in the file name: IntergerInput -> IntegerInput
Will need to update also those links:
vocs.config.ts:link: "/components/IntergerInput",- Components overview:
[IntegerInput](/components/IntergerInput) - Input field for integer values
| text: "⚙ Components", | ||
| items: [ | ||
| { | ||
| text: "overview", |
There was a problem hiding this comment.
nit: should we capitalize first "O" all the overview links as "Overview"?
| link: "/", | ||
| }, | ||
| { | ||
| text: "🚀 Quick Start", |
There was a problem hiding this comment.
nit: Some section don't have overview anymore (which makes sense because those removed were just link aggregators in the old docusaurus), should we add a redirect to the homepage to not have broken links SEO wise? Probably not a big deal, just if it's easy to config, we're missing these links in vocs:
- /quick-start
- /recipes
- /deploying
| link: "/disable-type-linting-error-checks", | ||
| }, | ||
| { | ||
| text: " Extensions", |
There was a problem hiding this comment.
nit: maybe a Windows thing. I don't see a emoji anymore here, in Docusaurus version I could see: 🔌
Pabl0cks
left a comment
Pabl0cks
left a comment
There was a problem hiding this comment.
nit: we don't have a footer on vocs. Probably not a big deal, but might be nice to keep it?
Looks like adding a footer.tsx in [docs] folder is enough.
Vibe coded footer.tsx
export default function Footer() {
return (
<div style={{
borderTop: '1px solid var(--vocs-color-border)',
marginTop: '40px',
paddingTop: '40px',
paddingBottom: '40px',
fontSize: '14px',
color: 'var(--vocs-color-text-2)' // Muted text color
}}>
<div style={{
display: 'flex',
flexWrap: 'wrap',
justifyContent: 'space-between',
gap: '40px',
maxWidth: '100%',
}}>
{/* Column 1: Built With */}
<div style={{ display: 'flex', flexDirection: 'column', gap: '12px' }}>
<h4 style={{ fontWeight: 'bold', fontSize: '16px', color: 'var(--vocs-color-text)', margin: 0 }}>
Built with ♥ at BuidlGuidl
</h4>
<a href="https://buidlguidl.com" target="_blank" rel="noreferrer" style={linkStyle}>
BuidlGuidl Website
</a>
<a href="https://twitter.com/buidlguidl" target="_blank" rel="noreferrer" style={linkStyle}>
BuidlGuidl Twitter
</a>
</div>
{/* Column 2: GitHub */}
<div style={{ display: 'flex', flexDirection: 'column', gap: '12px' }}>
<h4 style={{ fontWeight: 'bold', fontSize: '16px', color: 'var(--vocs-color-text)', margin: 0 }}>
GitHub
</h4>
<a href="https://github.com/scaffold-eth/scaffold-eth-2" target="_blank" rel="noreferrer" style={linkStyle}>
Scaffold-Eth 2 GitHub ↗
</a>
<a href="https://github.com/scaffold-eth/se-2-docs" target="_blank" rel="noreferrer" style={linkStyle}>
Docs GitHub ↗
</a>
</div>
{/* Column 3: Social */}
<div style={{ display: 'flex', flexDirection: 'column', gap: '12px' }}>
<h4 style={{ fontWeight: 'bold', fontSize: '16px', color: 'var(--vocs-color-text)', margin: 0 }}>
Social
</h4>
<a href="https://twitter.com/ScaffoldETH" target="_blank" rel="noreferrer" style={linkStyle}>
Twitter ↗
</a>
<a href="https://t.me/+GCApAirsRNBlN2Yx" target="_blank" rel="noreferrer" style={linkStyle}>
Telegram ↗
</a>
<a href="https://www.youtube.com/c/austingriffith" target="_blank" rel="noreferrer" style={linkStyle}>
Youtube ↗
</a>
</div>
</div>
<div style={{
textAlign: 'center',
marginTop: '40px',
fontSize: '12px',
opacity: 0.6
}}>
Copyright © {new Date().getFullYear()} Scaffold-eth Docs. Built with Vocs.
</div>
</div>
)
}
// Simple hover effect helper
const linkStyle = {
textDecoration: 'none',
color: 'inherit',
transition: 'opacity 0.2s',
opacity: 0.8
}
There was a problem hiding this comment.
I think we can delete it, unused
There was a problem hiding this comment.
I think we can delete it, unused
There was a problem hiding this comment.
I think we can delete it, unused
There was a problem hiding this comment.
I think we can delete it, unused
| ``` | ||
|
|
||
| For more information about available extensions and how to use them, check out the [Extensions section](/extensions) | ||
| For more information about available extensions and how to use them, check out the [Extensions section](/extensions/howToInstall) |
There was a problem hiding this comment.
nit: before we were pointing to /extensions. Should we keep it or you replaced it on purpose?
Pabl0cks
left a comment
Pabl0cks
left a comment
There was a problem hiding this comment.
Should we add the "Suggest changes to this page" button like the viem/vocs docs? We had "Edit" button on Docusaurus which was pretty much the same, a link to the github doc.
There was a problem hiding this comment.
nit: we can rename to index.md so instead of having a /external-contracts/external-contracts url, we would have just /external-contracts.
If we change, we'd need to update the link from the vocs config and from /hooks/index.md
Pabl0cks
left a comment
Pabl0cks
left a comment
There was a problem hiding this comment.
AWESOME JOB @technophile-04 !! You’ve tackled a really big task!
I've added some comments, mostly nitpicks. Feel free to ignore those that make no sense for you 🙌
Description:
This is ready to review 🙌 you check test the docs at :
https://scaffold-eth-2-docs-git-vocs-buidlguidldao.vercel.app/
TODO:
Cookbook AI integration, maybe we can tackle in next PR.