Skip to content

Getting Started is missing most of what you need to get started #139

@felzix

Description

@felzix

I can't get tiddlyserver to work because there just isn't documentation in the obvious place (if anywhere?) that explains the total steps.

Missing information:

  • How to make an account. It isn't clear why there are accounts nor how to set them up. Digging into the documentation for the settings JSON, I figured out how to do this step, but that information should be in Getting Started because it appears to be 100% necessary for the "happy path".
  • There should be a complete settings JSON in the documentation. The current state of the default JSON is pretty good and the documentation is extensive but having a single fully-fleshed-out JSON is helpful. In particular, I ran into the issue where my authAccounts were missing the group and the config verifier didn't tell me that fact. Also I am unsure what groups are for... I realllllly just want a server for myself so I don't need to remember to click save or get interrupted every time I edit a page.
  • Unsure what the PUT thing is. Like obviously it's supposed to talk to the server but I read the code and still don't understand... I am skeptical it works as expected since it seems to be pulling from the document URL, which for tiddlywiki is a file path. Is there some other way to use tiddlywiki with tiddlyserver?

As it stands, it tells me it saved only when it's set up to ask me to save every time I edit a page. It doesn't seem to actually use tiddlyserver.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions