burm
burm copied to clipboard
William-McGonagle
Create Documentation Website
Hello, first timer here, can I work on this? Also is there an available design to follow
Yeah sure- there's really no design to work on at this point, the only thing I would say is try to get it working with CI/CD so that we never have to manually update it. Thanks for helping!
Alright no problem, I don't have experience with working with CI/CD, I'll find a way to figure that out. While I'll be trying to figure that out, I'll start on the website creation taking inspiration from other documentation websites. Anyways I'll still be asking a few questions.
I can help you with a starter web design created in figma and see it if you like it, I have never contributed on github so I would love to contribute and help in this early stage, can you provide extra information on how would you like to have your landing page designed?
No problem with that, I'll appreciate that, it'll be easier when I have something to follow. @namanthanki
Hey @namanthanki If you want to build a landing page or documentation page, just theme it similar to how Bun is designed. Thanks for helping!
@William-McGonagle Hi, I tried creating first prototype of the landing page and I kept it single section, single page philosophy with thought that current needs of documentation can be showcased through github readme however in future we might need a separate documentation page but as of now I have tried my best to keep it simple and stupid, with your recommendation in consideration I have tried to make it similar to bun site but with touch of its own color scheme, let me know what you think about it. If you approve this page I can turn it into real working page and share it with you in no time
Figma Link (If you want to play around): https://www.figma.com/file/ob0d2DLDifcEk28jmMUuti/Burm?node-id=0%3A1
I think this looks good @namanthanki
@William-McGonagle does it matter if i build the website using plain html, css, js or nextjs.
I think the design looks great @namanthanki. I think that we should change the color from green to something more doughy and bun-like though- what are everyone's thoughts on that?
Also @adetyaz, you can build it however you would like. It just has to be able to deploy to Github pages and preferably works with CI/CD.
Sidenote- This is just an idea, but wouldn't it be cool if you queried data from the NPM API, so that the documentation system could be used for other projects.
@William-McGonagle With your consideration I have tried my best to come up with a color palette which is more doughy themed as you mentioned, let me know your thoughts about this
@namanthanki I think it looks great! Thank you so much for helping with the project- do you also think the documentation needs a design, or do you think that we should just use a template?
@William-McGonagle Yes documentation page could be designed as well, as of now I am trying to look for inspiration to create a minimalistic documentation page, I'll let you know if I create any prototypes.
@namanthanki is the recent design the one that'll be used or you have plans on making changes to it?
@adetyaz that's the one, it's the landing page we're going to use as of now. If you need any help in designing or writing code let me know