Skip to content
This repository has been archived by the owner on May 4, 2020. It is now read-only.

Render the Behat API doc #27

Open
stof opened this issue Jan 6, 2015 · 6 comments
Open

Render the Behat API doc #27

stof opened this issue Jan 6, 2015 · 6 comments

Comments

@stof
Copy link
Member

stof commented Jan 6, 2015

This can be useful for extension authors. I git several complaints about the fact that the Mink API doc is not available online anymore since the removal of the old website for instance.
I don't know whether it should be handled by Borg itself or be deployed separately (which might be easier)

@everzet
Copy link
Member

everzet commented Jan 7, 2015

That's a great idea.

@everzet
Copy link
Member

everzet commented Jan 7, 2015

Not sure if it fits in first release though.

@stof
Copy link
Member Author

stof commented Jan 7, 2015

It would probably be easier to render them separately using Sami or phpdocumentor (depending of your preference) rather than deploying them in Borg itself.
Then, the needed work is to automate building the API doc (which would allow us to have the API doc for branches updated automatically either each day or for each code push through a webhook). This part can be either a separate project or be in Borg. Note that I'm thinking about building such doc builder for Mink too, so it might be best kept as a separate tool.

@everzet
Copy link
Member

everzet commented Jan 7, 2015

@stof the current codebase of Borg will make things like that trivial. Also Borg is highly decouple from the Behat. You technically will be able to use Borg to create Mink or any other OSS project website.

@stof
Copy link
Member Author

stof commented Jan 7, 2015

@everzet the thing is, building API docs is related to releases of the code, not of the doc. When they live in separate repositories, this is a different trigger.

@everzet
Copy link
Member

everzet commented Jan 7, 2015

@stof Borg is capable of handling both. It doesn't distinguish which releases you give it ATM. It should become clearer when we add extension pages.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants