QPQ-AG/sophia
10
0
Fork 0
Code Issues 41 Pull Requests 5 Actions Packages Projects Releases 16 Wiki Activity

restructure doc files for readTheDocs #773

Closed
zxq9 wants to merge 9 commits from github/fork/nikita-fuchs/lima into lima
pull from: github/fork/nikita-fuchs/lima
merge into: QPQ-AG:lima
Conversation 32 Commits 9 Files Changed 10 +3656 -269
zxq9 commented 2020-10-07 00:22:59 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: nikita-fuchs

currently, the readTheDocs documentation at https://aeternity-sophia.readthedocs.io/ points to my WIP restructuring, it should be fine though now to merge it to the official doc. content wise, I left the "big" sophia.md in place just as an internal reference. Regarding the protected calls: In the final text, there is a note about it not being implemented yet. as soon as things are merged, I will point the readthedocs link to the official sophia repo, as it should be.

*Created by: nikita-fuchs* currently, the readTheDocs documentation at https://aeternity-sophia.readthedocs.io/ points to my WIP restructuring, it should be fine though now to merge it to the official doc. content wise, I left the "big" `sophia.md` in place just as an internal reference. Regarding the `protected calls`: In the final text, there is a note about it not being implemented yet. as soon as things are merged, I will point the readthedocs link to the official sophia repo, as it should be.
zxq9 commented 2020-10-07 04:41:26 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

No... Again, this is not right. This is the Lima branch, this isn't implemented on Lima.

*Created by: hanssv* No... Again, this is not right. This is the Lima branch, this isn't implemented on Lima.
zxq9 commented 2020-10-07 04:42:38 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

Review: Changes requested

The Lima branch has documentation of things implemented in Lima. Period.

Either merge this to master or remove the things not implemented in Lima.

*Created by: hanssv* **Review:** Changes requested The Lima branch has documentation of things implemented in Lima. Period. Either merge this to master or remove the things not implemented in Lima.
zxq9 commented 2020-10-07 05:14:58 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: nikita-fuchs

this file was for internal reference only anyway.

*Created by: nikita-fuchs* this file was for internal reference only anyway.
zxq9 commented 2020-10-08 01:40:21 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

remove

*Created by: hanssv* remove
zxq9 commented 2020-10-08 01:40:29 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

remove

*Created by: hanssv* remove
zxq9 commented 2020-10-08 01:41:38 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

remove

*Created by: hanssv* remove
zxq9 commented 2020-10-08 01:42:29 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

keep the old version

*Created by: hanssv* keep the old version
zxq9 commented 2020-10-08 01:43:03 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

Remove this example doesn't make sense on lima.

*Created by: hanssv* Remove this example doesn't make sense on lima.
zxq9 commented 2020-10-08 01:43:33 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

Review: Commented

Marked up the stuff that should and shouldn't change.

*Created by: hanssv* **Review:** Commented Marked up the stuff that should and shouldn't change.
zxq9 commented 2020-10-13 21:33:50 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: nikita-fuchs

can you check, @hanssv ?

*Created by: nikita-fuchs* can you check, @hanssv ?
zxq9 commented 2020-10-15 01:27:19 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

AENS.update should be in this list eventually, but no hurry it isn't released yet...

*Created by: hanssv* AENS.update should be in this list eventually, but no hurry it isn't released yet...
zxq9 commented 2020-10-15 01:28:32 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

Here a warning that Auth.tx isn't available until Iris is is missing.

*Created by: hanssv* Here a warning that Auth.tx isn't available until Iris is is missing.
zxq9 commented 2020-10-15 01:31:57 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

This isn't available until Iris.

*Created by: hanssv* This isn't available until Iris.
zxq9 commented 2020-10-15 01:32:56 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

A lot of this isn't available until Iris

*Created by: hanssv* A lot of this isn't available until Iris
zxq9 commented 2020-10-15 01:33:28 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

This library isn't available until Iris

*Created by: hanssv* This library isn't available until Iris
zxq9 commented 2020-10-15 01:35:07 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

Maybe I missed this one, but nevertheless, Auth.tx isn't in iris, so neither should its documentation.

*Created by: hanssv* Maybe I missed this one, but nevertheless, Auth.tx isn't in iris, so neither should its documentation.
zxq9 commented 2020-10-15 01:36:09 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

Iris only, shouldn't be in this branch.

*Created by: hanssv* Iris only, shouldn't be in this branch.
zxq9 commented 2020-10-21 22:58:28 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: nikita-fuchs

this file shall be deleted after the merge, it's just the big template for creating the separate files.

*Created by: nikita-fuchs* this file shall be deleted after the merge, it's just the big template for creating the separate files.
zxq9 commented 2020-10-21 22:59:55 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: nikita-fuchs

done.

*Created by: nikita-fuchs* done.
zxq9 commented 2020-10-21 23:00:06 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: nikita-fuchs

marked.

*Created by: nikita-fuchs* marked.
zxq9 commented 2020-10-21 23:00:14 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: nikita-fuchs

marked.

*Created by: nikita-fuchs* marked.
zxq9 commented 2020-10-21 23:00:20 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: nikita-fuchs

marked.

*Created by: nikita-fuchs* marked.
zxq9 commented 2020-10-21 23:00:32 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: nikita-fuchs

Removed.

*Created by: nikita-fuchs* Removed.
zxq9 commented 2020-10-27 21:31:00 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: nikita-fuchs

Did I miss anything, @hanssv ?

*Created by: nikita-fuchs* Did I miss anything, @hanssv ?
zxq9 commented 2020-10-29 04:51:53 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

Only Auth.tx is coming in Iris, the rest is already there. But there are no users of this, so nevermind 😢

*Created by: hanssv* Only Auth.tx is coming in Iris, the rest is already there. But there are no users of this, so nevermind 😢
zxq9 commented 2020-10-29 04:52:39 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

Review: Commented

You comment "marked" to a lot of things, but I see no marks @nikita-fuchs ?

*Created by: hanssv* **Review:** Commented You comment "marked" to a lot of things, but I see no marks @nikita-fuchs ?
zxq9 commented 2020-10-29 20:02:31 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: radrow

Maybe worth noting "local mutable" by the way

- A contract may define a type `state` encapsulating its local mutable
*Created by: radrow* Maybe worth noting "local mutable" by the way ```suggestion:-0+0 - A contract may define a type `state` encapsulating its local mutable ```
zxq9 commented 2021-01-26 20:05:47 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: marc0olo

@hanssv I am planning to test generalized accounts and provide some examples in the near future ;-) ... but I don't know when I will find the time to do so. will definitely play around with it because we also want to support the feature in the java sdk

*Created by: marc0olo* @hanssv I am planning to test generalized accounts and provide some examples in the near future ;-) ... but I don't know when I will find the time to do so. will definitely play around with it because we also want to support the feature in the java sdk
zxq9 commented 2021-04-26 18:35:09 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: nikita-fuchs

hello everyone, I'm not aware exactly how much the documentation has progressed internally already, but as this is what the public is currently served through readTheDocs, could we please merge this restructuring of the files and continue working on these documents here so things don't drift apart too far? If we wait too long getting this one here up to date will be a bit tedious I fear.

*Created by: nikita-fuchs* hello everyone, I'm not aware exactly how much the documentation has progressed internally already, but as this is what the public is currently served through readTheDocs, could we please merge this restructuring of the files and continue working on these documents here so things don't drift apart too far? If we wait too long getting this one here up to date will be a bit tedious I fear.
zxq9 commented 2021-04-30 00:24:24 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: omar-saadoun

Hey guys @hanssv @radrow any feedback here ?

*Created by: omar-saadoun* Hey guys @hanssv @radrow any feedback here ?
zxq9 commented 2021-04-30 00:48:14 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: hanssv

Until the things that @nikita-fuchs commented as "marked" above is actually fixed I see no reason to merge this. But I really don't care, I know how the compiler works 😛 Also we are quickly approaching Iris, so it would probably make sense to prepare properly for that. I assume there is a plan for that?

I'll leave it to @radrow and @nikita-fuchs to untangle the mess they've created. Unfortunately you can't unrequest changes without actually accepting the PR so lets fix things first.

*Created by: hanssv* Until the things that @nikita-fuchs commented as "marked" above is actually fixed I see no reason to merge this. But I really don't care, I know how the compiler works 😛 Also we are quickly approaching Iris, so it would probably make sense to prepare properly for that. I assume there is a plan for that? I'll leave it to @radrow and @nikita-fuchs to untangle the mess they've created. Unfortunately you can't unrequest changes without actually accepting the PR so lets fix things first.
zxq9 commented 2021-10-11 17:05:55 +09:00 (Migrated from gitlab.com)
Copy Link

Created by: marc0olo

I think this can be closed now as we have mkdocs now active on https://aeternity.com/aesophia

*Created by: marc0olo* I think this can be closed now as we have mkdocs now active on https://aeternity.com/aesophia

Pull request closed

This pull request cannot be reopened because the branch was deleted.
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
WIP
bug
consensus-breaking
dependencies
documentation
duplicate
effort: high
effort: low
effort: medium
effort: trivial
enhancement
good first issue
help wanted
invalid
maintenance
question
task/feature
todo-in-rewrite
wontfix
bug
Something is not working
duplicate
This issue or pull request already exists
enhancement
New feature
help wanted
Need some help
invalid
Something is wrong
pig lipstick
Muggle-facing enhancements
question
More information is needed
wontfix
This won't be fixed
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: QPQ-AG/sophia#773
No description provided.
Delete Branch "github/fork/nikita-fuchs/lima"

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?