search

silverstripe / api.silverstripe.org

API documentation for the Silverstripe Framework
BSD 3-Clause "New" or "Revised" License
3 stars 14 forks source link

Link to Github source code #59

Closed chillu closed 3 years ago

chillu commented 6 years ago

The old API generator inlined the PHP code - and it looks like many people miss that (see https://github.com/silverstripe/silverstripe-framework/issues/7625).

williamdes commented 3 years ago

/close ?

ntd commented 3 years ago

I am one of the people missing the good ol' link. I just checked the online documentation and the issue is still present.

williamdes commented 3 years ago

Do you mean the at line x on https://laravel.com/api/5.8/Illuminate/Auth/Events/Authenticated.html ?

Can you explain more ? Or open an issue at https://github.com/code-lts/doctum ?

ntd commented 3 years ago

Do you mean the at line x on https://laravel.com/api/5.8/Illuminate/Auth/Events/Authenticated.html ?

No, the links work fine for laravel: I meant the online SilverStripe API. There the at line ... references are just plain text, see e.g. https://api.silverstripe.org/4/SilverStripe/Admin/ModelAdmin.html

Maybe it just needs to be updated.

williamdes commented 3 years ago

Oh yeah it only needs the https://github.com/code-lts/doctum#configuration 'remote_repository' => new GitHubRemoteRepository('username/repository', '/path/to/repository'),

I had to use an external repository for the example ;p

chillu commented 3 years ago

@williamdes We already have remote_repository in the project section of the config, but it doesn't apply? https://github.com/silverstripe/api.silverstripe.org/blob/master/conf/doctum.php#L82

I'm a bit unclear on how we can set this separately for each package, the API docs are a composite of multiple repos (silverstripe/framework, silverstripe/cms etc)

williamdes commented 3 years ago

Looks like it doesn't work on your side I will have a look ASAP