Skip to content

Make SourceKit-LSP’s documentation more discoverable #1584

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

Merged
merged 2 commits into from
Jul 26, 2024

Conversation

ahoppen
Copy link
Member

@ahoppen ahoppen commented Jul 24, 2024

No description provided.

@ahoppen ahoppen requested review from MaxDesiatov and bnbarham July 24, 2024 15:54
@ahoppen ahoppen force-pushed the documentation-more-discoverable branch from 399edf8 to 3f43bd2 Compare July 24, 2024 16:19
@ahoppen
Copy link
Member Author

ahoppen commented Jul 24, 2024

@swift-ci Please test


## Developer Documentation

The following documentation documents are primarily intended for developers of SourceKit-LSP.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we link to these from CONTRIBUTING.md instead?

Copy link
Member Author

Choose a reason for hiding this comment

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

I split the documentation into the Documentation folder (documentation for users of SourceKit-LSP) and Contributor Documentation (for contributors) and link to Contributor Documentation from CONTRIBUTING.md.

@ahoppen ahoppen force-pushed the documentation-more-discoverable branch from 98c9c4c to b33da96 Compare July 25, 2024 22:11
@ahoppen ahoppen force-pushed the documentation-more-discoverable branch from b33da96 to 7c99397 Compare July 25, 2024 22:12
@ahoppen
Copy link
Member Author

ahoppen commented Jul 25, 2024

@swift-ci Please test

@ahoppen
Copy link
Member Author

ahoppen commented Jul 25, 2024

@swift-ci Please test Windows

@ahoppen ahoppen merged commit 7ecae09 into swiftlang:main Jul 26, 2024
3 checks passed
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.

3 participants