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

Upate README #28

Closed
1 task done
PSchmiedmayer opened this issue Jan 28, 2025 · 0 comments · Fixed by #29
Closed
1 task done

Upate README #28

PSchmiedmayer opened this issue Jan 28, 2025 · 0 comments · Fixed by #29
Assignees
Labels
enhancement New feature or request

Comments

@PSchmiedmayer
Copy link
Member

Problem

Thank you for merging the #27 PR @lukaskollmer!

While looking at the merged README I noticed that a few symbols don't contain a link. Nothing major but would be nice to address now that we should be able to link them in the Swift Package index; sorry for missing this in the PR review.

Solution

Smaller things I noticed in the README that might also apply to some DocC articles.

  • Add links to all code symbols in the markdown
  • Use research paper title capitalization for section headers and other titles such as PR titles.
  • Fix the Important: formatting in the README
  • Remove "Example: " from the title of the headings.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct and Contributing Guidelines
@PSchmiedmayer PSchmiedmayer added the enhancement New feature or request label Jan 28, 2025
@lukaskollmer lukaskollmer self-assigned this Jan 28, 2025
@github-project-automation github-project-automation bot moved this from Backlog to Done in Project Planning Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants