Skip to content

Commit

Permalink
[DOCS] Improve TW Readme structure (#8634)
Browse files Browse the repository at this point in the history
  • Loading branch information
pmario committed Sep 25, 2024
1 parent c64e94f commit 501cb7b
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 18 deletions.
26 changes: 19 additions & 7 deletions editions/tw5.com/tiddlers/about/Developers.tid
Original file line number Diff line number Diff line change
@@ -1,17 +1,29 @@
created: 20150412191004348
modified: 20201222114745463
modified: 20240925114810504
tags: Community Reference
title: Developers
type: text/vnd.tiddlywiki

! [[GitHub Stats|https://github.com/TiddlyWiki/TiddlyWiki5/graphs/contributors]]

There are several resources for developers to learn more about TiddlyWiki and to discuss and contribute to its development.

> [img[https://repobeats.axiom.co/api/embed/5a3bb51fd1ebe84a2da5548f78d2d74e456cebf3.svg]]

* [[tiddlywiki.com/dev|https://tiddlywiki.com/dev]] is the official developer documentation

* Get involved in the [[development on GitHub|https://github.com/TiddlyWiki/TiddlyWiki5]]
** [img[https://repobeats.axiom.co/api/embed/5a3bb51fd1ebe84a2da5548f78d2d74e456cebf3.svg]]
** [[Discussions|https://github.com/TiddlyWiki/TiddlyWiki5/discussions]] are for Q&A and open-ended discussion
** [[Issues|https://github.com/TiddlyWiki/TiddlyWiki5/issues]] are for raising bug reports and proposing specific, actionable new ideas
* The older ~TiddlyWikiDev Google Group is now closed in favour of [[GitHub Discussions|https://github.com/TiddlyWiki/TiddlyWiki5/discussions]] but remains a useful archive: https://groups.google.com/group/TiddlyWikiDev
** An enhanced group search facility is available on [[mail-archive.com|https://www.mail-archive.com/tiddlywikidev@googlegroups.com/]]
* Follow [[@TiddlyWiki on Twitter|http://twitter.com/#!/TiddlyWiki]] for the latest news

* [[GitHub Discussions|https://github.com/TiddlyWiki/TiddlyWiki5/discussions]] are for Q&A and open-ended discussion
* [[GitHub Issues|https://github.com/TiddlyWiki/TiddlyWiki5/issues]] are for raising bug reports and proposing specific, actionable new ideas

* The older ~TiddlyWikiDev Google Group is now closed in favour of [[Talk TiddlyWiki|https://talk.tiddlywiki.org/]] and [[GitHub Discussions|https://github.com/TiddlyWiki/TiddlyWiki5/discussions]]
** It remains a useful archive: https://groups.google.com/group/TiddlyWikiDev
*** An enhanced group search facility is available on [[mail-archive.com|https://www.mail-archive.com/tiddlywikidev@googlegroups.com/]]

* Chat at https://gitter.im/TiddlyWiki/public (development room coming soon)

! Twitter

* Follow [[@TiddlyWiki on Twitter|http://twitter.com/#!/TiddlyWiki]] for the latest news

16 changes: 10 additions & 6 deletions editions/tw5.com/tiddlers/community/Forums.tid
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
created: 20140721121924384
modified: 20220131165124489
modified: 20240925113748341
tags: Community
title: Forums
type: text/vnd.tiddlywiki

! Official Forums

The new official forum for talking about ~TiddlyWiki: requests for help, announcements of new releases and plugins, debating new features, or just sharing experiences. You can participate via the associated website, or subscribe via email.
!! https://talk.tiddlywiki.org/

https://talk.tiddlywiki.org/
<<<
The new official forum for talking about ~TiddlyWiki: requests for help, [[announcements|https://talk.tiddlywiki.org/c/announcements/20]] of new releases and plugins, debating new features, or just sharing experiences. You can participate via the associated website, or subscribe via email.

Note that talk.tiddlywiki.org is a community run service that we host and maintain ourselves. The modest running costs are covered by community contributions.
''talk.tiddlywiki.org'' is a community run service that we host and maintain ourselves. The modest running costs are covered by community contributions.
<<<

For the convenience of existing users, we also continue to operate the original ~TiddlyWiki group (hosted on Google Groups since 2005):
!!! Google Groups

https://groups.google.com/group/TiddlyWiki
<<<
For the convenience of existing users, we also continue to operate the original ~TiddlyWiki group (hosted on Google Groups since 2005): https://groups.google.com/group/TiddlyWiki
<<<

! Developer Forums

Expand Down
20 changes: 15 additions & 5 deletions editions/tw5.com/tiddlers/readme/ReadMe.tid
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
created: 20131129094758194
modified: 20140920135213536
modified: 20240925115259828
title: ReadMe
type: text/vnd.tiddlywiki

\define tv-wikilink-template() https://tiddlywiki.com/static/$uri_doubleencoded$.html
\import [subfilter{$:/core/config/GlobalImportFilter}]

! Welcome

Welcome to TiddlyWiki, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation.

TiddlyWiki is a complete interactive wiki in JavaScript. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable WikiText.
~TiddlyWiki is a complete interactive wiki in ~JavaScript. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable WikiText.

!! Demo

Learn more and see it in action at https://tiddlywiki.com/

!! Developer Documentation

Developer documentation is in progress at https://tiddlywiki.com/dev/

! Join the Community
Expand All @@ -20,15 +26,19 @@ Developer documentation is in progress at https://tiddlywiki.com/dev/
<$transclude mode="block" tiddler="Forums"/>
</$vars>

! Installing TiddlyWiki on Node.js
---

! Installing ~TiddlyWiki on Node.js

~TiddlyWiki is a SingleFileApplication, which is easy to use. For advanced users and developers there is a possibility to use a Node.js client / server configuration. This configuration is also used to build the ~TiddlyWiki SinglePageApplication

{{Installing TiddlyWiki on Node.js}}

! Using TiddlyWiki on Node.js
! Using ~TiddlyWiki on Node.js

{{Using TiddlyWiki on Node.js}}

! Upgrading TiddlyWiki on Node.js
! Upgrading ~TiddlyWiki on Node.js

{{Upgrading TiddlyWiki on Node.js}}

Expand Down

0 comments on commit 501cb7b

Please sign in to comment.