Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flesh out README #26

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Flesh out README #26

wants to merge 11 commits into from

Conversation

J-Vaughan
Copy link
Contributor

@J-Vaughan J-Vaughan commented Sep 29, 2020

🚧 It's not ready yet, don't merge 🚧
So all that's really left (for the first barebones readme) is:

I will accept this in new PR Project roadmap (#31)

@J-Vaughan J-Vaughan marked this pull request as draft September 29, 2020 20:55
@J-Vaughan

This comment has been minimized.

@J-Vaughan J-Vaughan requested a review from saihaj October 5, 2020 05:13
Copy link
Member

@saihaj saihaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should have a symlink for this Readme. docs/README.md should be pointed to root level Readme (i.e. the one you are working right now). All these should go in docs so that the docs website is also up-to date.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@J-Vaughan
Copy link
Contributor Author

I think we should have a symlink for this Readme. docs/README.md

I'm actually not able to push to this branch for some reason. So far, I've just been making edits and copying them into the github editor.

@saihaj
Copy link
Member

saihaj commented Oct 5, 2020

You should have write access to this repo. Let me see and update it

@J-Vaughan
Copy link
Contributor Author

Okay, I've finally softlinked it. I'm not happy with the README rn, but it's just the MVP, right? I've sort of split out the todo list in the first post to a Project, and I've opened Issues. I think that this pull request should just be focussed on the README, and I think it's ready to merge. It'll change later, but this is okay for now. Thanks.

@J-Vaughan J-Vaughan marked this pull request as ready for review November 1, 2020 17:54
@J-Vaughan J-Vaughan requested a review from saihaj November 1, 2020 17:55
Copy link
Contributor Author

@J-Vaughan J-Vaughan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The links were fixed

@saihaj
Copy link
Member

saihaj commented Nov 1, 2020

It would be great if you can link the todo items to their corresponding issue you opened

@J-Vaughan
Copy link
Contributor Author

It would be great if you can link the todo items to their corresponding issue you opened

Got it :)

This was linked to issues Nov 21, 2020
J-Vaughan and others added 10 commits November 20, 2020 23:20
There's still a couple links to non-existent files still
Co-authored-by: ਸਹਜਪ੍ਰੀਤ ਸਿੰਘ <saihajpreet.singh@gmail.com>
Co-authored-by: ਸਹਜਪ੍ਰੀਤ ਸਿੰਘ <saihajpreet.singh@gmail.com>
Is this a soft link? No. Is this what I would've done on linux? Also no. Is creating softlinks prohibited by Windows without workarounds? I don't care. I hate windows and I'm 2 seconds away from nuking this installation and installing guix >:(
@saihaj saihaj removed their request for review May 12, 2023 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] detail how eslinting/commitlinting works [meta] license
3 participants