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

Improve docs formatting and fix filename conflicts #1666

Merged
merged 2 commits into from
Jun 21, 2024

Conversation

sarahraqueld
Copy link
Contributor

@sarahraqueld sarahraqueld commented Jun 21, 2024

Problems

  1. There are a few markdown formatting errors, such as duplicate header and empty links.
  2. Cloning this repo on a case-insensitive file system (the default for macOS) results in the following message.
warning: the following paths have collided (e.g. case-sensitive paths
on a case-insensitive filesystem) and only one from the same
colliding group is in the working tree:

  'docs/src/SUMMARY.md'
  'docs/src/summary.md'

Solutions

  1. Add links and change header hierarchies
  2. Rename summary.md to intro.md

co-authored-by @smaboshe

@sarahraqueld sarahraqueld changed the title Rename summary.md to intro.md to avoid filenames clash Improve docs formatting and fix filename conflicts Jun 21, 2024
@sarahraqueld sarahraqueld force-pushed the sl-ss-fix-file-name-clash branch from bde728e to c1dfcb1 Compare June 21, 2024 09:57
@sarahraqueld
Copy link
Contributor Author

The CI is failing with an unrelated issue, so we'll merge this and fix it in a separate PR.

Copy link
Contributor

@smaboshe smaboshe left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thanks for taking care of this! 🎉

@sarahraqueld sarahraqueld merged commit 4ee1d21 into main Jun 21, 2024
24 of 25 checks passed
@sarahraqueld sarahraqueld deleted the sl-ss-fix-file-name-clash branch June 21, 2024 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants