cory/tildefriends
5
6
Fork 2
Code Issues 28 Pull Requests Actions Releases 39 Wiki Activity

WIP: Write documentation #55

Closed
tasiaiso wants to merge 22 commits from tasiaiso/tildefriends:tasiaiso-documentation into main
pull from: tasiaiso/tildefriends:tasiaiso-documentation
merge into: cory:main
Conversation 5 Commits 22 Files Changed 25 +1223 -142
tasiaiso commented 2024-05-11 08:54:37 -04:00
Contributor
Copy Link

Closes #54

  • How to build & run TF
    • Installing packages
    • Building
      • Troubleshooting / FAQ
    • Running
      • Quick start guide
      • Troubleshooting / FAQ
  • How TF works under the hood
    • Architecture
  • How to develop and contribute
    • Philosophy
    • How to get changes merged
      • Procedure
      • Best practices
    • Create a new app
    • tfrpc
    • Guidelines: what is acceptable, what is not
      • C: need fedback from Cory
      • JS: need fedback from Cory
      • Docs
    • Establish defaults: example: should core apps be developed with w3.css or tildefriends.css ? Both ? Need fedback from Cory
  • Add a code of conduct ? example I like Need fedback from Cory
  • Bug report template
  • PR template
  • Release notes: List breaking changes, if any

Minor change unrelated to documentation:

  • chore: don't format flake.lock
Closes #54 - [x] How to build & run TF - [x] Installing packages - [x] Building - [x] Troubleshooting / FAQ - [x] Running - [ ] Quick start guide - [ ] Troubleshooting / FAQ - [ ] How TF works under the hood - [ ] Architecture - [ ] How to develop and contribute - [ ] Philosophy - [ ] How to get changes merged - [ ] Procedure - [ ] Best practices - [ ] Create a new app - [ ] tfrpc - [ ] Guidelines: what is acceptable, what is not - [ ] C: need fedback from Cory - [ ] JS: need fedback from Cory - [x] Docs - [ ] Establish defaults: example: should core apps be developed with w3.css or tildefriends.css ? Both ? Need fedback from Cory - [ ] Add a code of conduct ? [example I like](https://github.com/Xe/creators-code/blob/master/CODE_OF_CONDUCT.md) Need fedback from Cory - [ ] Bug report template - [x] PR template - [ ] Release notes: List breaking changes, if any Minor change unrelated to documentation: - chore: don't format flake.lock
tasiaiso added 1 commit 2024-05-11 08:54:37 -04:00
chore(docs): add markdownlint-cli 396f37ee3b
tasiaiso added 3 commits 2024-05-11 14:06:52 -04:00
docs: new documentation 34c7fa8312
chore: rename lint script to format, tell prettier to ignore markdown files 69b2e2a955
chore: small changes in README and LICENSE 5551fd2dea
tasiaiso reviewed 2024-05-11 15:53:16 -04:00
docs/building.md
@@ -0,0 +12,4 @@
Dependencies for Android:
- TODO
tasiaiso commented 2024-05-11 15:53:16 -04:00
Author
Contributor
Copy Link

@cory can you help me fill those in ?

@cory can you help me fill those in ?
👍 1
tasiaiso reviewed 2024-05-11 15:53:26 -04:00
docs/building.md
@@ -0,0 +16,4 @@
Dependencies for iOS:
- TODO
tasiaiso commented 2024-05-11 15:53:26 -04:00
Author
Contributor
Copy Link

same

same
tasiaiso reviewed 2024-05-11 15:53:32 -04:00
docs/building.md
@@ -0,0 +20,4 @@
Dependencies for Windows:
- TODO
tasiaiso commented 2024-05-11 15:53:32 -04:00
Author
Contributor
Copy Link

same

same
tasiaiso added 3 commits 2024-05-11 15:55:03 -04:00
docs: more docs guidelines 0751699bc8
chore(doc): run and modify formatting rules 85ac8080f4
docs: remove unicode chars 5c8c6e8760
tasiaiso reviewed 2024-05-11 15:59:40 -04:00
docs/running.md
@@ -0,0 +4,4 @@
The binaries should appear at `out/debug/tildefriends` and `out/release/tildefriends`.
For Android, iOS and Windows: TODO
tasiaiso commented 2024-05-11 15:59:40 -04:00
Author
Contributor
Copy Link

@cory I need help for that too

@cory I need help for that too
tasiaiso added 2 commits 2024-05-12 02:09:47 -04:00
docs: running.md 2bb6d68122
docs: docs, misc changes fae2771645 
- instruction for writing apps
- add NOTES.md to .gitignore
tasiaiso requested review from cory 2024-05-12 02:33:19 -04:00
tasiaiso added 1 commit 2024-05-12 03:05:01 -04:00
docs: you can add another git remote 9f3a3808f9
tasiaiso added 5 commits 2024-05-12 05:21:47 -04:00
docs: guideline 3 7d77e398d4
docs: move documentation out of guide.md ae3430bf56
docs: misc 5b7d0f1aa1
docs: delete guide.md 12599b5723
docs: misc d7eda01c16
tasiaiso added 1 commit 2024-05-17 02:09:08 -04:00
Merge branch 'main' into tasiaiso-documentation 43f6a3a482
tasiaiso added 4 commits 2024-05-23 07:12:24 -04:00
docs: issue & pr templates draft f2a3c790dd
docs: fix links 80c1463a5c
docs: formatting 912747bdac
add result to gitignore 1b3b9e570e
tasiaiso added 1 commit 2024-05-23 07:13:57 -04:00
Merge commit '580688381e08d2b6df67f146118f9c4e38b37f78' into tasiaiso-documentation f31ec0338b
tasiaiso added 1 commit 2024-05-23 07:16:04 -04:00
chore: don't format flake.lock 9c8772c898
cory commented 2025-02-27 18:58:45 -05:00
Owner
Copy Link

I'm closing this, as things have drifted and I've failed at wrapping my head around what I really want here, but I've opened #112 with most of the still-open documentation tasks.

I'm closing this, as things have drifted and I've failed at wrapping my head around what I really want here, but I've opened #112 with most of the still-open documentation tasks.
cory closed this pull request 2025-02-27 18:58:45 -05:00

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
Reviewers
No Reviewers
tasiaiso
cory
Labels
No items
No Label
Milestone
No items
No Milestone
Assignees
Clear assignees
cory
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: cory/tildefriends#55
Delete Branch "tasiaiso/tildefriends:tasiaiso-documentation"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?