Skip to content
This repository has been archived by the owner on Feb 24, 2024. It is now read-only.

as issue #41, first DRAFT #42

Closed
wants to merge 1 commit into from
Closed

Conversation

ppKrauss
Copy link
Contributor

plug-and-play steps, instructions for dummies

plug-and-play steps, instructions for dummies
@begriffs
Copy link
Member

Thanks a lot! I'll review this in the next couple days.

@begriffs
Copy link
Member

This is a helpful introduction, I think it will make it easier for people to get started. It is currently written in Markdown syntax, could you convert it to reStructuredText? Then it needs to either be put inside an existing section or added as a new section, see index.rst for how to manipulate the table of contents for the docs.

I just added a readme to this project that explains how to build it on your own machine to preview your changes.

@begriffs
Copy link
Member

Just noting here that the old version of the docs had a getting started section in the examples. https://postgrest.readthedocs.io/en/v0.3.2/examples_start.html

You could copy some stuff out of there if you like.

@begriffs
Copy link
Member

Actually don't worry about finishing this. I can use what you wrote and incorporate it into the docs because I'm pretty familiar with the docs system.

I'll close this PR, but add a note to my todo list to add "instructions for dummies." I like what you wrote, it'll be a helpful structure for my writing.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants