docs: create Docusaurus documentation site for Copilot by Detox #29
Conversation
website/docusaurus.config.js
Outdated
| favicon: '/img/homepage/detox-logo.png', | ||
|
|
||
| // Set the production url of your site here | ||
| url: 'https://your-docusaurus-site.example.com', |
There was a problem hiding this comment.
I believe this is better to be updated.
There was a problem hiding this comment.
How does 'https://copilotbydetox.com/' sound?
There was a problem hiding this comment.
Where do you deploy it to, currently?
There was a problem hiding this comment.
I don't know actually. Can I just choose to deploy to this address?
There was a problem hiding this comment.
@LironMShemen no, to deploy to a domain we need to buy it.. Someday maybe
There was a problem hiding this comment.
Let's start with a plain deployment to github pages
There was a problem hiding this comment.
Also, please fix your .nvmrc to use lts/jod (Node 22), instead of that embarrasing thing inside: 😅 I mean, just like a grenade that did not explode, there's this snippet of Shell script there inside:
echo "20" > .nvmrc
Overall, good job, but a few places still need some polish.
website/src/pages/index.js
Outdated
| <img | ||
| src="/img/homepage/copilot-demo.gif" | ||
| alt="Demo Gif" | ||
| className={styles.bottomRightGif} |
There was a problem hiding this comment.
I’m not convinced that GIF is the best solution in this case.
- It does not compress well; consider using WebP or other more modern formats instead.
- To enhance user experience, a video file (WebM or whatever) would be ideal. This allows viewers to open it in fullscreen mode, pause/resume, etc. making it more usable, especially on mobile devices.
|
And also, please check the narrow viewport (360px+). I don't think your layout looks clean enough there (uneven distances between elements, and abruptly ending bottom padding, at the very least, is what I can notice). Here's my suggestion (actual vs what-i-would-have-expected-maybe), maybe it will help:
↑ The positioning of the image (whether it has to be 2nd, or 3rd, or 4th) — is not something I am firmly decided on, but still... I tend to believe that it's best to put it either 2nd or 3rd element in this vertical stack. I think, being the last element doesn't make it a good advertising job, especially if it gets cropped on 640px height viewport devices. |
LironMShemen
force-pushed
the
copilot-doc-site
branch
from
48665ea to
a03e89d
Compare
asafkorem
force-pushed
the
copilot-doc-site
branch
from
d384b26 to
f993e45
Compare
…tial commit This commit adds a new Docusaurus-based documentation site with: ### Guides Section: - **Integrating with Testing Frameworks:** Overview of Copilot's capabilities. - **Technical Overview:** Adapted from Detox docs (to be removed there). - **Best Practices:** Framework-agnostic step-by-step guidance. - **Custom Driver Implementation:** Guide to creating and adding testing framework drivers. - **Contributing:** Details on adding prompt handlers and drivers, with tips and github link. ### API Section: - **Interface Overview:** Lifecycle commands (`init`, `start`, `perform`, `end`). - **Prompt Handlers:** Writing and contributing (`src/prompt-handlers`). - **Framework Drivers:** Custom implementation, snapshot support, and type references. ### Showcase Page: - Highlights Detox as the initial use case and invites collaboration with other frameworks. chore: md and mdx files with the content of the website chore: svg and icon files chore: scss files chore: feature changes and main page Instead of Detox 6 features, now only 2 relevant features are presented. In addition, instead of the gif, we created fixed repetitive component. css fix: fix the side bar navigation chore chore: Changes due to code review **Docusaurus leftovers were deleted. **The link to edit the page was updated. **The URL for the website was updated.
LironMShemen
force-pushed
the
copilot-doc-site
branch
from
f993e45 to
cf6ce3e
Compare
|
Great job @LironMShemen! I will publish the site soon 🙂 |
This commit adds a new Docusaurus-based documentation site with:
Guides Section:
API Section:
init,start,perform,end).src/prompt-handlers).Showcase Page: