tuist/XcodeProj

Add documentation

Open

#831 opened on Jul 20, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Swift (353 forks)github user discovery
good first issue

Repository metrics

Stars
 (2,217 stars)
PR merge metrics
 (Avg merge 7d 20h) (9 merged PRs in 30d)

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

Research direction
Set up a Vitepress documentation site following the example from Tuist. Include Quickstart guidelines for using the package to create or update an XcodeProj.
Tech stack
vuejavascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75