Local Panel
Local SSH server manager with no subscriptions or installs
Start new thread

Built docs and a subreddit for Local Panel | what should we document next?

by•

Hello PH 👋🏽

We realised that people aren’t really aware of what they can do with Local Panel; it’s probably just being used to access the terminal easily or to manage files. However, Local Panel is much more than that, and we wondered what we could do to demonstrate this.

We’ve decided to publish a It’s still a work in progress, but rather than ploughing ahead blindly, we’d like to get your thoughts: what should we include in the guide? Are the current sections sufficient? Are they detailed enough? Or are they a bit too dry?

We’ve also taken the first step towards building a . We’re planning a subreddit where you can share what you’ve created with Local Panel, get help, and where we’ll be actively involved.

I look forward to hearing your thoughts on these developments.

43 views

Add a comment

Replies

Best

If I were prioritizing documentation, I'd focus on beginner onboarding. I've noticed many projects explain what features do but not the fastest path from installation to a successful first result.

 I'd love to understand how Local Panel works behind the scenes, what components interact with each other, and the reasoning behind major desighn decision

   Your thoughts are truly very valuable to me and I’m adding them to my list. To be honest, as the installation simply involves downloading from the store, I carried out that step within the quick start guide because I thought that adding a server would be the first successful task to be carried out after installation.

I thought the concept behind Local Panel was actually very straightforward and that its functionality was quite clear. Local Panel is an advanced, end-user-focused software with a graphical interface that runs SSH commands on your behalf. Everything you do within the application corresponds to an SSH command running in the background, and to be honest, we do not intend to explain what those commands are.

I'd definitely add a "Real-world workflows" section.

Instead of documenting every feature individually, show complete tasks from start to finish. for example, deploying an app, managing a server, troubleshooting logs, or setting up a new environment. Those examples help users understand not just how a feature works, but when to use it.

Seeing practical workflows usually shortens the learning curve much more than feature documentation alone.

 Real-world workflows are an idea I’ve come across many times, and I think people really need them and appreciate them. As for the fact that it shortens the learning curve, I certainly agree. Am I right in thinking that feature documentation is a documentation system required for more advanced users?

 I think both are important, but they serve different audiences.

I'd start with real-world workflows because that's what helps new users become productive quickly. Once they're comfortable, they'll naturally look for detailed feature documentation to unlock more advanced use cases.

In my experience, people usually search for "How do I achieve this?" before they search for "How does this feature work?"

 That makes sense; the question asked really is an important one. Thank you for your perspective.

I think real-world use cases would be the most valuable thing to document.

A lot of users don't struggle with "how" to use a feature, they struggle with "why" they should use it and what they can build with it.

Also, building a community around user creations is a smart move. Sometimes the best documentation comes from seeing what other people have already built. Great updates!

 I’m glad you like the idea of a community. I’ve seen the idea of real-world workflows mentioned several times; I think this is definitely what people need.

Do you think it would be helpful if there were workflow templates within the app that people could browse and use straight away?