Parse-Swift
Parse-Swift copied to clipboard
Remove duplicate docs
New Issue Checklist
- [x] I am not disclosing a vulnerability.
- [x] I am not just asking a question.
- [x] I have searched through existing issues.
- [x] I can reproduce the issue with the latest versions of Parse Server and the Parse Swift SDK.
Issue Description
The docs here contain a lot of copy/paste from the Parse Server repo. This makes the docs difficult to maintain, as info needs be kept in sync. In addition, the copied info is sometimes truncated, which may case misunderstandings and provides less value than the original longer and more detailed docs.
Common docs that are referenced across Parse Platform repos may be best kept in a separate repo, but we currently don't have such a repo, other than maybe the governance repo. Until we have such a common repo or find another approach, individual repos should only reference the docs in the Parse Server repo, not duplicate their information.
Steps to reproduce
For example compare:
- https://github.com/parse-community/Parse-Swift/blob/main/CONTRIBUTING.md
- https://github.com/parse-community/parse-server/blob/alpha/CONTRIBUTING.md
Actual Outcome
n/a
Expected Outcome
n/a
Environment
n/a
Thanks for opening this issue!
- 🚀 You can help us to fix this issue faster by opening a pull request with a failing test. See our Contribution Guide for how to make a pull request, or read our New Contributor's Guide if this is your first time contributing.
@cbaker6 Do you have a suggestion on how to solve this? Otherwise I would just remove the duplicate parts.
Off topic: The GitHub About section of this repo reads (I rephrased it recently):
The Swift SDK for Parse Platform (iOS, macOS, watchOS, tvOS, Linux, Android)
Are there any docs about how to use the Parse Swift SDK in Android?
Otherwise I would just remove the duplicate parts.
duplicate parts can be removed and/or linked to the server document
Are there any docs about how to use the Parse Swift SDK in Android?
“Windows” needs to be added to this section… There are no docs needed to use for Android or any other OS as they all use SPM. Anyone building swift on another platform should know SPM is available. Any other requirement for other OS’s are in the API docs.
“Windows” needs to be added to this section
added
duplicate parts can be removed and/or linked to the server document
ok