---
# System prepended metadata

title: Documentation

---

# Documentation

## Present Vincent's Work

- Interface to help people without much experience in LD
- library : tripledoc


## Vocabulary/phrasing issues

- Document has an acception that might be misleading to a new user

## List Documentation Needed

Prioritised:
| Scope | Target audiences | id | Assignments | Estimates |
| --- | --- | --- | --- | --- |
| Get your feet wet on building Solid Apps | JavaScript App Developers with no Linked Data Experience | 1 | Vincent | 3 |
| How to do common operations when writing an app (cheatsheet, cf vincent tripledoc) | People in the process of writing an App | 9 | Vincent | 5 |
| Common patterns in Solid apps (notifications, etc.) | Solid app developers |17| Nicolas (/SDK Team?/Sarven) | 8 |
| Deploy IPS for local testing | Solid App Developers |4| Jackson | 5 |
| Understanding Solid | JavaScript App Developers |12| Jackson | 8 |
| Understanding Solid | Enterprise architects |10| Nicolas (Paul/Pat/Aaron)| 12 |
| Understanding Solid | Prospective users |11| Jackson | 8 |
| Relevant vocabularies and shapes | App developers | 19 | Nicolas | 5 |
| Finding relevant vocabularies | App developers | 21 |Nicolas | 2 |
| Deploy IPS as a Pod Provider | Professional Pod Hosts |5| Jackson| 5 |
| Deploy IPS on a personal machine | DIY hosters |6| Jackson| 5 |
| Common patterns when setting up IPS (setting up certificates, etc.) | Pod hosters |18| Jackson | 8 |
| Where to get help | App developers | 29 |  Vincent | 2 | 
| How/where to advertise your app | App developers | 28 | Vincent (Jackson: "submit your own app") | 2 |
| How to use LIT-generated artifacts | Solid app developers | 30 | Nicolas | 3 |
| How to generate and publish your own Vocabulary artifacts using LIT | Solid app developers | 23 | Nicolas | 5 |
| API documentation for solid-auth-client | App developers | 27 | Vincent | 5 |
| Solid's authentication pattern | Security consultants |13 | Jackson | 1 |
| Deploy ESS as a Pod Providers  | Enterprise Pod Hosts | 3 | Nicolas | 12 |
| API documentation for rdflib | App developers | 24 | Vincent | 21

Unprioritised:
| Scope | Target audiences | id |
| --- | --- | --- |
| The mobile app tutorial | Mobile app developers | 2 |
| Writing apps in a graph-oriented way (later) | Advanced Solid App Developers |7|
| How to pick an RDF library | People getting started writing an app |8|
| Access control in Solid | Security consultants |14|
| Access control in Solid | App developers |15|
| Access control in Solid | Pod managers |16|
| How to create your own vocabulary | App developers | 20 |
| Where to learn more about Linked Data |  | 22 |
| API documentation for ldflex | App developers | 25 |
| API documentation for rdf-ext | App developers | 26 |


### Pitches

- For user
- For developers
- For enterprises



## Extensions to documentation

### Interactive introduction

- For the "Getting your feet wet" tutorial, we could have an interactive sandbox with a sign-in button for the parts that require authentication.
- Provide a default read-only pod with dummy login/password for people without a pod ("pure" app dev)
- Interactive tutorial for acl

### MOOC

- Especially adapted to overview

## Related work

- Cross-reference documentations
    - reference best practices in LD when building app for instance
- Linked Data Patterns: http://patterns.dataincubator.org/book/
- Cool uris
- Bibliography

### Reuse of existing documentation
- From information/documentation
- Four main axes
    - pod
    - app
    - idp
    - general introduction to Solid for people first hearing about it

### Later
- Set solidproject.org as a solid server
- enable receiving notifications for app registration


## Priorities

## Work Estimates

## What to publish where

- All content lives on SolidProject.org
- IPS is the reference server, so its docs live there as well - but it should be clear that it's an Inrupt project.
- ESS on a separate website/inrupt.com?
- Tutorials should be written in MD
- Add a note: authored by `x` courtesy of Inrupt

## Assignments