Futura-Py / TimerX

A fluent Timer App, made completely in Python
https://timerx-app.netlify.app
MIT License
37 stars 5 forks source link

chore(docs): Update+add documentation #42

Closed im-coder-lg closed 2 years ago

im-coder-lg commented 2 years ago

For now, it's just the first commit, I'll continue soon, maybe tomorrow.

netlify[bot] commented 2 years ago

鉁旓笍 Deploy Preview for timerx-app canceled.

馃敤 Explore the source changes: d103e2d1f64f35a3246a531f27ffbbcfa25869d7

馃攳 Inspect the deploy log: https://app.netlify.com/sites/timerx-app/deploys/61dd398db32fed00079d96ff

im-coder-lg commented 2 years ago

WIP

Browser metadata ``` Path: /docs/contributing Browser: Chrome 96.0.4664.137 on Windows 7 Viewport: 1269 x 655 @1x Language: en-US Cookies: Enabled ``` [Open in BrowserStack](https://www.browserstack.com/user/try-live?url=https%3A%2F%2Fdeploy-preview-42--timerx-app.netlify.app%2Fdocs%2Fcontributing&os=Windows&os_version=7&browser=Chrome&browser_version=96.0&resolution=1269x655&speed=1&start=true&ref=netlify-source)

Open Deploy PreviewMark as Resolved

im-coder-lg commented 2 years ago

Ah that's me, can you approve me as a reviewer?

not-nef commented 2 years ago

Yo i can commit cool

im-coder-lg commented 2 years ago

I'll manage from here, can you just supervise?

im-coder-lg commented 2 years ago

No offense, I need some help frankly.

im-coder-lg commented 2 years ago

Yo i can commit cool

Collaborator rights :sunglasses:

im-coder-lg commented 2 years ago

Renamed the title semantically, how's that?

not-nef commented 2 years ago

semantically?

im-coder-lg commented 2 years ago

The cz c way? It's semantic.

not-nef commented 2 years ago

what does it mean

im-coder-lg commented 2 years ago

If you compare Add my own image to my blog and feat(blog): my own image, you will say the second one is better than the first. This is semantic committing. Also @sumeshir26 thanks for approving me as a reviewer.

im-coder-lg commented 2 years ago

Is the contributing guide fine? Any changes to add? Link: https://deploy-preview-42--timerx-app.netlify.app/docs/contributing

Open Deploy PreviewMark as Resolved

sumeshir26 commented 2 years ago

Can we remove this: https://deploy-preview-42--timerx-app.netlify.app/docs/intro?

im-coder-lg commented 2 years ago

No, that's the landing page. We can use it as a welcome page, right>

Browser metadata ``` Path: /docs/intro Browser: Chrome 96.0.4664.137 on Windows 7 Viewport: 1269 x 655 @1x Language: en-US Cookies: Enabled ``` [Open in BrowserStack](https://www.browserstack.com/user/try-live?url=https%3A%2F%2Fdeploy-preview-42--timerx-app.netlify.app%2Fdocs%2Fintro&os=Windows&os_version=7&browser=Chrome&browser_version=96.0&resolution=1269x655&speed=1&start=true&ref=netlify-source)

Open Deploy PreviewMark as Resolved

im-coder-lg commented 2 years ago

Browser metadata is irritating. Also, I'll edit the intro page, can you add the homepage link to the README and the repo description?

sumeshir26 commented 2 years ago

Ok

im-coder-lg commented 2 years ago

Any ideas on the intro page? Need some text that's why.

im-coder-lg commented 2 years ago

Can anyone else test c288b78? Also, any other ideas?

Browser metadata ``` Path: /docs/compile/ Browser: Firefox 95.0 on Windows 7 im-coder-lg: no respect for personal privacy, eh? Viewport: 1304 x 683 @1x Language: en-US Cookies: Enabled ``` [Open in BrowserStack](https://www.browserstack.com/user/try-live?url=https%3A%2F%2Fdeploy-preview-42--timerx-app.netlify.app%2Fdocs%2Fcompile%2F&os=Windows&os_version=7&browser=Firefox&browser_version=95.0&resolution=1304x683&speed=1&start=true&ref=netlify-source)

Open Deploy PreviewMark as Resolved

im-coder-lg commented 2 years ago

I think I will edit the homepage a bit.

sumeshir26 commented 2 years ago

@im-coder-lg Look at my review

im-coder-lg commented 2 years ago

Where's it?

Browser metadata ``` Path: /docs/compile Browser: Chrome 97.0.4692.71 on Windows 7 Viewport: 1304 x 665 @1x Language: en-GB Cookies: Enabled ``` [Open in BrowserStack](https://www.browserstack.com/user/try-live?url=https%3A%2F%2Fdeploy-preview-42--timerx-app.netlify.app%2Fdocs%2Fcompile&os=Windows&os_version=7&browser=Chrome&browser_version=97.0&resolution=1304x665&speed=1&start=true&ref=netlify-source)

Open Deploy PreviewMark as Resolved

sumeshir26 commented 2 years ago

Its right above this comment: image

im-coder-lg commented 2 years ago

Right above https://github.com/sumeshir26/TimerX/pull/42#issuecomment-1008549823, there is https://github.com/sumeshir26/TimerX/pull/42#issuecomment-1008544552. Try re-commenting that.

im-coder-lg commented 2 years ago

I'll be offline for now, it's school. I'll be back by 2:00 PM IST.

im-coder-lg commented 2 years ago

I'm back! Now, I will try adding some screenshots to the homepage. @sumeshir26 when you are free, can you give me a desktop screenshot containing TimerX's main window, the configurator window and the settings window(all open simultaneously please)? I'll add them to the homepage.

sumeshir26 commented 2 years ago

I feel like the current image on the README looks nice, it looks cluttered if you open all the windows

sumeshir26 commented 2 years ago

Also, can repl.it be added to the contributing guide?

im-coder-lg commented 2 years ago

Also, can repl.it be added to the contributing guide?

I'll add that now!

im-coder-lg commented 2 years ago

I feel like the current image on the README looks nice, it looks cluttered if you open all the windows

It's for the docs homepage. Or, I think the best thing to do is, you take a windowed screenshot of TimerX and send it here. I'll add it to docs/src/pages/HomepageFeatures.js. Make sure there are no borders other than the apps border, kinda like macOS screenshots.

im-coder-lg commented 2 years ago

Just one more thing to add, the screenshot.

im-coder-lg commented 2 years ago

Also, can we try making a triage table for TimerX? It might be clear to understand and GitHub provides this, unfortunately you need to make a project for your account globally. I will try finding some solution to this though, that would increase productivity.

sumeshir26 commented 2 years ago

It alreaday has one: https://github.com/sumeshir26/TimerX/projects/1

im-coder-lg commented 2 years ago

But that doesn't have tables, that's why I asked. It shows a board, not a table-like view. I mean that it has to look like an Excel spreadsheet.

im-coder-lg commented 2 years ago

Trello offers a GitHub integration as well as tabled organizing of cards. But I think we could use something that's already on GitHub.

im-coder-lg commented 2 years ago

I removed the old review, it told that it was pending, so dismissed it with "Resolved".

im-coder-lg commented 2 years ago

I have to be changing the footer!

im-coder-lg commented 2 years ago

Wait, replit guide needed!

im-coder-lg commented 2 years ago

Hey how do we add custom Unicode emojis to Chrome? Becuase I hopped onto a live BrowserStack device running macOS Monterey, Safari 15.1 and they allowed the emoji.

Browser metadata ``` Path: /docs/contributing#replit Browser: Chrome 97.0.4692.71 on Windows 7 Viewport: 1304 x 665 @1x Language: en-GB Cookies: Enabled ``` [Open in BrowserStack](https://www.browserstack.com/user/try-live?url=https%3A%2F%2Fdeploy-preview-42--timerx-app.netlify.app%2Fdocs%2Fcontributing%23replit&os=Windows&os_version=7&browser=Chrome&browser_version=97.0&resolution=1304x665&speed=1&start=true&ref=netlify-source)

Open Deploy PreviewMark as Resolved

im-coder-lg commented 2 years ago

Oh, it's globally for macOS.

Browser metadata ``` Path: /docs/contributing#replit Browser: Chrome 97.0.4692.71 on Windows 7 Viewport: 1304 x 665 @1x Language: en-GB Cookies: Enabled ``` [Open in BrowserStack](https://www.browserstack.com/user/try-live?url=https%3A%2F%2Fdeploy-preview-42--timerx-app.netlify.app%2Fdocs%2Fcontributing%23replit&os=Windows&os_version=7&browser=Chrome&browser_version=97.0&resolution=1304x665&speed=1&start=true&ref=netlify-source)

Open Deploy PreviewMark as Resolved

im-coder-lg commented 2 years ago

/ping @sumeshir26 can you review please?

sumeshir26 commented 2 years ago

@im-coder-lg Did you add the screenshot?

im-coder-lg commented 2 years ago

Did you add the screenshot?

No, I will add it later. It seems like we all have a busy schedule. I will be busy till lunchtime.

Starting now.

im-coder-lg commented 2 years ago

Merge this PR after my commit on the master branch. CI fails and I know why.

im-coder-lg commented 2 years ago

Don't, I need to update docs.

im-coder-lg commented 2 years ago

Fixed, ready.

im-coder-lg commented 2 years ago

Ready for merge!