[Xastir] Poll: how do you like your documentation served up?
VE7MHI John D Erskine
va7otc at vivaldi.net
Mon Dec 15 17:52:44 PST 2025
On 2025.12.11 10:46, Tom Russo wrote:
> Xastir's documentation is a bit, um, fragmented? We have READMEs of
> various
> vintages, we've got a wiki that is sometimes (but not often) kept
> up-to-date.
>
> I am starting to look into revamping more of our documentation,
> starting
> with README.MAPS (which is very, very outdated and not at all a good
> resource for first time users). I have to decide whether to rewrite
> the
> whole file or pitch it and just do the documentation on the wiki. We
> already have a "HowTo:MAPS" wiki page which is a subset of README.MAPS
> and
> almost as out of date. I don't want to have to maintain TWO
> documentation
> sets, as keeping them synced is a maintenance headache.
>
> So, of you remaining Xastir users, what would you prefer to look at:
> README
> files or a wiki, or something else?
>
> And if you can imagine yourself being a first-time Xastir user, what
> would
> you prefer to be told to do when you have to learn how to do something
> for
> the first time:
> "go look at our wiki on page xxxxx" or "go read the file README.XXX" or
> something else?
>
>
> And while I'm at it: "do you actually use Xastir anymore?"
I've a new-to-me box that is hoping for Xastir this winter. While I've
been here since the beginning I'm easily a beginner. I think a Wiki
might be the most useful.
Last wknd I ended up with an unplanned dive into the docs for N1MM+. I
was only looking for one thing, however the docs proved so good that I
kept going, a learning.
So, "go look at our wiki on page xxxxx" would like work for me.
HyperText is truly a wonderful thing.
Thanks to the shakers here.
Cheers, John
--
John D Erskine
VE7MHI VA7OTC
CN88hk NA-036
Victoria, B.C.
More information about the Xastir
mailing list