Add documentation
Open
Nobody has claimed this yet.
good first issue
- Dominant language
- Swift
- Stars
- 2.2k
- Forks
- 355
- Avg merge
- 5h 48m
- Merged PRs (30d)
- 13
Description
We should set up a documentation website using Vitepress like we do with Tuist, and make it available through https://xcodeproj.tuist.io. In it we should include some Quickstart guidelines for people wanting to use the package for creating an XcodeProj or updating an existing one.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how Tuist sets up its VitePress documentation website. Define the documentation site for xcodeproj.tuist.io and add Quickstart guidance for creating an XcodeProj or updating an existing project. Done means the site is available at the requested URL and includes both workflows.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- documentation, web-dev
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100