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

Ep 2 READMEs improvements #28

Closed
6 tasks done
Joe-Heffer-Shef opened this issue Jul 23, 2024 · 0 comments · Fixed by #43
Closed
6 tasks done

Ep 2 READMEs improvements #28

Joe-Heffer-Shef opened this issue Jul 23, 2024 · 0 comments · Fixed by #43

Comments

@Joe-Heffer-Shef
Copy link
Collaborator

Joe-Heffer-Shef commented Jul 23, 2024 •
edited
Loading

  • Mention that not everyone follows this structure
  • Typo "maintainers. - It should" remove dash
  • Use discussion callout type
  • Explain what a markup language is (explain the markup syntax versus rendered page)
  • Challenge: do some Markdown formatting
  • Reduce the number of key points
@Joe-Heffer-Shef Joe-Heffer-Shef changed the title Ep 2 READMEs Ep 2 READMEs improvements Jul 23, 2024
Joe-Heffer-Shef added a commit that referenced this issue Sep 12, 2024
@Joe-Heffer-Shef
Tweak content
ac6615b 
 Mention that not everyone follows this structure
 Typo "maintainers. - It should" remove dash
 Use discussion callout type
 Explain what a markup language is (explain the markup syntax versus rendered page)

#28
@Joe-Heffer-Shef Joe-Heffer-Shef linked a pull request Sep 12, 2024 that will close this issue
Episode 2 tweaks #43
Merged
@Joe-Heffer-Shef Joe-Heffer-Shef mentioned this issue Sep 12, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Episode 2 tweaks FAIR2-for-research-software/Documentation
1 participant
@Joe-Heffer-Shef