[docs] SDK Reference

[jazlan01]

Description

The current boilerplate for a new pipe contains a lot of fluff, extra stuff. Most of the content is not useful for someone trying to develop a new pipe which does not depend on the Obsidian code. Moreover, the documentation for a new pipe is terrible, with very little information about how to update content.

Suggested Changes

I would recommend the following changes (happy to help out with these)

• Extensive rework of the developer documentation. This would include

  • An explanation of how to create settings for a plugin, including files to modify
  • An explanation (or a simple link) to the NextJS API route documentation
  • A better reference for the default functionality available under the screenpipe/js package
  • An explanation of the data flow, with specific instructions on where we can modify different parts of the functionality (e.g. I want to update the cron schedule, or I want to update the user settings, or what does the usePipeSettings function return)

• For the starter template

  • A complete removal of all obsidian related code. The obsidian code can be offered as a template, instead of the default
  • Simpler entry points, something like the default NextJS app
  • A starter frontend template with form input with Zod, and a simple frontend (instead of a shadcn frontend with graphs etc)

additional context

For reference, it took me a long time to just remove the boilerplate and get started with developing my own pipe which does not depend on 90% of the starter code.

[louis030195]

thx! would love any contributions to gain clarity

cc @m13v