Tutorial Link to Full API

[bockthom]

The tutorial links to the full API. Is this link still correct. If so, does the linked file also need some updates?

worldofcode.org/docs/tutorial.md

Line 203 in 1164f50

For more examples [see full API](https://bitbucket.org/swsc/lookup/src/master/README.md).

[hrz6976]

Hi Thomas, I’m not sure what does “correct” mean, but it is the tutorial showing in the new woc website. I copied those markdown files because some of the syntaxes are breaking and causing rendering errors in the documentation site. Here are two ways to update the docs: 1. Sync changes to ssc-oscar/woc-frontend (Better in my opinion; it’s nicer to put docs in one place) 2. Fix the syntaxes and use the remote file feature like: https://github.com/ssc-oscar/woc-frontend/blob/1164f5012ebbe5e32a199990f07a5ceecab6efa4/docs/guide_remote.md Best, Runzhi

…

2025年4月23日 05:41，Thomas Bock ***@***.***> 写道： bockthom created an issue (ssc-oscar/worldofcode.org#4) The tutorial links to the full API. Is this link still correct. If so, does the linked file also need some updates? https://github.com/ssc-oscar/woc-frontend/blob/1164f5012ebbe5e32a199990f07a5ceecab6efa4/docs/tutorial.md?plain=1#L203-L203 — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you are subscribed to this thread. <https://aus01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fssc-oscar%2Fwoc-frontend%2Fblob%2F1164f5012ebbe5e32a199990f07a5ceecab6efa4%2Fdocs%2Ftutorial.md%3Fplain%3D1%23L203-L203&data=05%7C02%7C%7C2ea6ff3b313640e1d85008dd81e668d0%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C638809548800868571%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=rsf9T9oHIKuCNEK4H%2FCp2%2FDa0tfhdfQBnqpX5EvGT7E%3D&reserved=0> <https://aus01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fssc-oscar%2Fwoc-frontend%2Fissues%2F4&data=05%7C02%7C%7C2ea6ff3b313640e1d85008dd81e668d0%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C638809548800884170%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=2gmq915SFW22z0Vu7PjEEdTV89YorEyMqai6Jj0aWgo%3D&reserved=0> <https://aus01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FALETPBZRI24V6BIAVU56QX3222ZPVAVCNFSM6AAAAAB3UYB6CSVHI2DSMVQWIX3LMV43ASLTON2WKOZTGAYTEMJYHE3TKMA&data=05%7C02%7C%7C2ea6ff3b313640e1d85008dd81e668d0%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C638809548801219606%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=K5JG4UcbdSoFAEr8CbaIY7orOKhQn%2FyUjShmFpKcfyo%3D&reserved=0> bockthom created an issue (ssc-oscar/worldofcode.org#4) <https://aus01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fssc-oscar%2Fwoc-frontend%2Fissues%2F4&data=05%7C02%7C%7C2ea6ff3b313640e1d85008dd81e668d0%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C638809548801230375%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=V7aLO0uwfhCo6YArUE2dqqEgIZWbwRk2uHaP1Fbabd4%3D&reserved=0> The tutorial links to the full API. Is this link still correct. If so, does the linked file also need some updates? https://github.com/ssc-oscar/woc-frontend/blob/1164f5012ebbe5e32a199990f07a5ceecab6efa4/docs/tutorial.md?plain=1#L203-L203 <https://aus01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fssc-oscar%2Fwoc-frontend%2Fblob%2F1164f5012ebbe5e32a199990f07a5ceecab6efa4%2Fdocs%2Ftutorial.md%3Fplain%3D1%23L203-L203&data=05%7C02%7C%7C2ea6ff3b313640e1d85008dd81e668d0%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C638809548801241230%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=GWmzc1r0GXMrlUOkDqCI8uot9sSyQL7P2HAoOwqJ5e0%3D&reserved=0> — Reply to this email directly, view it on GitHub <https://aus01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fssc-oscar%2Fwoc-frontend%2Fissues%2F4&data=05%7C02%7C%7C2ea6ff3b313640e1d85008dd81e668d0%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C638809548801250386%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=Rv8c3VGgQPiFH1P9WWvrv9bd%2FIAM1brCSSHk7DxtGqI%3D&reserved=0>, or unsubscribe <https://aus01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FALETPBZRI24V6BIAVU56QX3222ZPVAVCNFSM6AAAAAB3UYB6CSVHI2DSMVQWIX3LMV43ASLTON2WKOZTGAYTEMJYHE3TKMA&data=05%7C02%7C%7C2ea6ff3b313640e1d85008dd81e668d0%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C638809548801259406%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=O3zq5QuEa5NL6pk0aQAwpepncmIEyXpFJVFayTuEfes%3D&reserved=0>. You are receiving this because you are subscribed to this thread.

[bockthom]

@hrz6976, there seems to be a misunderstanding:
I already started to perform changes to the documentation in ssc-oscar/woc-frontend (see my current PR #1). That's the only repo where I will update anything now. However, in order to be able to complete my pull request, I need to figure out which parts are outdated and if so how to update them. All the issues that I have opened in this repository (ssc-oscar/woc-frontend) deal with information for which I don't know how to update them (with "how to update" I refer to the content, not syntax etc.)

So, I am seeking feedback from all of you who are more familiar with WoC than I am, to get your inputs on what the correct replacements for outdated information are so that I can change them correctly

In particular, in this issue here (#4), I would like to figure out whether it still makes sense to link to https://bitbucket.org/swsc/lookup/src/master/README.md in the documentation and if so, whether this needs to be updated or not.