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.

Sign up for GitHub

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

Jump to bottom

Update and/or Merge README files #95

Open
lunacodes opened this issue Feb 23, 2022 · 2 comments
Open

Update and/or Merge README files #95

lunacodes opened this issue Feb 23, 2022 · 2 comments
Assignees
@lunacodes

Comments

@lunacodes
Copy link
Contributor

The main./README.md and /content/README.md have redundant, but mismatched content. To-Dos need to be cleaned up and/or moved to GitHub Issues.
@lunacodes lunacodes self-assigned this Feb 23, 2022
lunacodes added a commit that referenced this issue Mar 24, 2022
@lunacodes
Initial draft of README rewrites. Also removes STAGING doc. #95
d20648d
lunacodes added a commit that referenced this issue Mar 24, 2022
@lunacodes
Improve organization, Add pretty links, Fix typos #95
a66a6c5
lunacodes added a commit that referenced this issue Mar 24, 2022
@lunacodes
Shorten EDITING table of contents. small Wording tweaks #95
b3d57c3
@lunacodes
Copy link
Contributor Author

@mr-c @swzCuroverse @kinow (or anyone else) I'd love feedback on this, if/when you have a moment. Particularly wondering if the structure makes sense, and if there's anything confusing, or anything that needs to be added.

Relevant Files:

@kinow
Copy link
Member

kinow commented Mar 25, 2022

Hi @lunacodes !

I don't know if the content/README.md is necessary. IMO if there's anything there, that is missing from README.md then we should move it to the main README.md and delete content/README.md.

How to edit Jekyll files, how to use plug-ins, call macros, what to include in the YAML header, etc, can go to content/EDITING.md, IMO. That would simplify the README.md, and help others when updating the site.

Just my 0.02 cents 👍

Thanks!

@lunacodes lunacodes mentioned this issue Mar 25, 2022
Merged
mr-c pushed a commit that referenced this issue Apr 14, 2022
@lunacodes @mr-c
Initial draft of README rewrites. Also removes STAGING doc. #95
ea62976
mr-c pushed a commit that referenced this issue Apr 14, 2022
@lunacodes @mr-c
Improve organization, Add pretty links, Fix typos #95
3df45c8
mr-c pushed a commit that referenced this issue Apr 14, 2022
@lunacodes @mr-c
Shorten EDITING table of contents. small Wording tweaks #95
f4abf39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lunacodes lunacodes

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kinow @lunacodes