cory/tildefriends
4
5
Fork 1
Code Issues 29 Pull Requests 1 Actions Releases 26 Wiki Activity

WIP: Write documentation #55

Draft
tasiaiso wants to merge 22 commits from tasiaiso/tildefriends:tasiaiso-documentation into main
pull from: tasiaiso/tildefriends:tasiaiso-documentation
merge into: cory:main
Conversation 0 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
tasiaiso added 3 commits 2024-05-11 14:06:52 -04:00
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
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 
- 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
tasiaiso added 5 commits 2024-05-12 05:21:47 -04:00
tasiaiso added 1 commit 2024-05-17 02:09:08 -04:00
tasiaiso added 4 commits 2024-05-23 07:12:24 -04:00
tasiaiso added 1 commit 2024-05-23 07:13:57 -04:00
tasiaiso added 1 commit 2024-05-23 07:16:04 -04:00
This pull request has changes conflicting with the target branch.
  • .gitignore
  • README.md
  • docs/guide.md
  • flake.lock
  • package-lock.json
View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u tasiaiso-documentation:tasiaiso-tasiaiso-documentation
git checkout tasiaiso-tasiaiso-documentation
Sign in to join this conversation.
Reviewers
No reviewers
cory
Labels
Clear labels
No items
No Label
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: cory/tildefriends#55
No description provided.
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?