Skip to content

Commit 4faca3a

Browse files
committed
Add docs foreword
1 parent 62c480d commit 4faca3a

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

docs/source/index.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,24 @@
33

44
Welcome to projspec, the projects' project!
55

6-
The "into" defined this package's scope and sets some definitions. The "quickstart"
7-
shows some of the concrete things you can actually do.
6+
There are many ways to organise project-oriented code workflows, and projspec aims
7+
to give a unified experience, so that you don't have to learn them all. This allows
8+
for the following types of use-cases:
9+
10+
- *browsing*: a project is _shared_ with you (github, gdrive, your corp's storage solution), and
11+
you want to know what it is and what it needs, without downloading and browsing a
12+
bunch of readme and scripts.
13+
- *search*: you have access to a large number of projects on your disk or elsewhere and you want
14+
to find the project that meets some criteria like "it uses package X", "it needs
15+
dataset Y" or "it can make a conda package". The names of directories alone are not enough.
16+
- *actions*: you want an app to launch in a single command without diving deeper. This may also
17+
extend to "deployment" scenarios where you want to be able to run many kinds of applications
18+
without building custom scripts every time.
19+
- *summaries*: you host projects for your org, and want to know how many are affected by some given
20+
CVE, or how many rely on a rust compiler.
21+
22+
The "intro" defined this package's scope and sets some definitions. The "quickstart"
23+
shows some of the concrete things you can actually do right now.
824

925
Introduction to projspec presented at PyData Global 2025: `video`_ | `slides`_
1026

0 commit comments

Comments
 (0)