Re: [webkit-dev] WebKit Documentation

[Simon Fraser via webkit-dev]

> On Mar 9, 2023, at 10:48 AM, Brandon Stewart via webkit-dev 
>  wrote:
> 
> Hello,
> 
> Sorry for the delay on the documentation update.
> 
> For getting the documentation system online, we were trying to settle on a 
> subdomain.
> 
> What would people prefer we use as the official documentation location:
> (1) docs.webkit.org
> (2) developer.webkit.org
> (3) documentation.webkit.org

Make both 1) and 3) work, choose one as the canonical one and have the other 
redirect. Minor preference for docs.webkit.org  as the 
canonical one.

Simon

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Carlos Alberto Lopez Perez via webkit-dev]

On 09/03/2023 19:48, Brandon Stewart via webkit-dev wrote:
> What would people prefer we use as the official documentation location:
> (1) docs.webkit.org
> (2) developer.webkit.org
> (3) documentation.webkit.org
> (4) Other
+1 for docs.webkit.org (shorter is better)
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Adrian Perez de Castro via webkit-dev]

Hi all,

On Thu, 09 Mar 2023 10:48:27 -0800 Brandon Stewart via webkit-dev 
 wrote:
 
> Sorry for the delay on the documentation update.
> For getting the documentation system online, we were trying to settle on a 
> subdomain.

Looking forward to have the documentation online ^_^
 
> What would people prefer we use as the official documentation location:
> (1) docs.webkit.org
> (2) developer.webkit.org
> (3) documentation.webkit.org
> (4) Other
> 
> Could you please reply to this e-mail indicating which origin you would 
> prefer?

One vote more for (1) because it's shorter top type, but (3) could do as well.

Cheers,
—Adrián


signature.asc
Description: PGP signature
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Vitor Ribeiro Roriz via webkit-dev]

I prefer (1) as well!On 12 Mar 2023, at 16:07, Brent Fulgham via webkit-dev  wrote:I prefer (1)!On Mar 9, 2023, at 5:54 PM, Kirsling, Ross via webkit-dev  wrote:







I’d vote for (1) since it’s easy to type!
 
Thanks,
Ross
 

From: Ryosuke Niwa via webkit-dev 
Reply-To: Ryosuke Niwa 
Date: Friday, March 10, 2023 at 6:41 AM
To: Brandon Stewart 
Cc: Ling Ho via webkit-dev 
Subject: Re: [webkit-dev] WebKit Documentation


 


 






On Mar 9, 2023, at 10:48 AM, Brandon Stewart via webkit-dev  wrote:




 



Sorry for the delay on the documentation update.


 


For getting the documentation system online, we were trying to settle on a subdomain.


 


What would people prefer we use as the official documentation location:


(1) docs.webkit.org


(2) developer.webkit.org


(3) documentation.webkit.org






 


(1) or (3) seems good.


 


- R. Niwa


 






On Feb 28, 2023, at 12:39 AM, dpino via webkit-dev  wrote:



On 9/20/22 05:28, Brandon Stewart via webkit-dev wrote:

Hi WebKit Developers,
 
Documentation is an important part of any open source project, especially for a larger project like WebKit. Being able to ramp up during the onboarding process, reading up on architectural decisions, and learning how to perform common procedures are all features the documentation should tackle. WebKit has a large set of documentation already, but it is scattered around a wide range of platforms (Trac, GitHub Wiki, markdown files in the code, Git commits, etc...), and some of the information is out of date.
 
A few months ago, I started working on a new documentation solution based on the DocC documentation framework. This provides an easy way to add and edit documentation through markdown files. I have already ported a large section of Trac, all of the GitHub Wiki, and all of the non third party markdown files in the code over to this platform. I have tested this on macOS and Linux and have found it works extremely well. (Windows should be able to use WSL2 at the moment, while a few remaining issues get sorted out). The only dependency for this project is a recent installation of Swift.
 
You can already download the documentation and preview it locally, but we are looking to publish it online for easy viewing. We were looking to get your feedback if we would want to publish the documentation on GitHub Pages or webkit.org.
 
The documentation source can be found at https://github.com/webkit/documentation.
 
- Brandon
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

H,
It has been more than 5 months since this new documentation repository was announced and as far as I know it hasn't been published yet. Is there any news when this site will be publicly available?
Right now in Igalia we need to publish some information publicly and we were discussing where it's the right place to put it.
  * WebKit Documentation (https://github.com/webkit/documentation.git),
 IMHO it doesn't make sense because the information needs to be public.
  * Trac (https://trac.webkit.org/wiki),
 since WebKit Documentation hasn't been published yet, the fact is that we have been updating Trac pages in the last months.
  * WebKit GitHub Wiki (https://github.com/WebKit/WebKit/wiki),
 it seems like the best candidate. It says that new documentation should live there instead of being added to Trac. But on the other hand when WebKit Documentation was announced some people advocated for keep using the GH Wiki but that idea was discarded. It
 seems like WebKit GitHub Wiki is were new documents should be published until WebKit Documentation site is not available? Please confirm whether this assumption is correct or not.
--
Diego

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev



 

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev


 




___webkit-dev mailing listwebkit-dev@lists.webkit.orghttps://lists.webkit.org/mailman/listinfo/webkit-dev___webkit-dev mailing listwebkit-dev@lists.webkit.orghttps://lists.webkit.org/mailman/listinfo/webkit-dev___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Brent Fulgham via webkit-dev]

I prefer (1)!On Mar 9, 2023, at 5:54 PM, Kirsling, Ross via webkit-dev  wrote:







I’d vote for (1) since it’s easy to type!
 
Thanks,
Ross
 

From: Ryosuke Niwa via webkit-dev 
Reply-To: Ryosuke Niwa 
Date: Friday, March 10, 2023 at 6:41 AM
To: Brandon Stewart 
Cc: Ling Ho via webkit-dev 
Subject: Re: [webkit-dev] WebKit Documentation


 


 






On Mar 9, 2023, at 10:48 AM, Brandon Stewart via webkit-dev  wrote:




 



Sorry for the delay on the documentation update.


 


For getting the documentation system online, we were trying to settle on a subdomain.


 


What would people prefer we use as the official documentation location:


(1) docs.webkit.org


(2) developer.webkit.org


(3) documentation.webkit.org






 


(1) or (3) seems good.


 


- R. Niwa


 






On Feb 28, 2023, at 12:39 AM, dpino via webkit-dev  wrote:



On 9/20/22 05:28, Brandon Stewart via webkit-dev wrote:

Hi WebKit Developers,
 
Documentation is an important part of any open source project, especially for a larger project like WebKit. Being able to ramp up during the onboarding process, reading up on architectural decisions, and learning how to perform common procedures are all features the documentation should tackle. WebKit has a large set of documentation already, but it is scattered around a wide range of platforms (Trac, GitHub Wiki, markdown files in the code, Git commits, etc...), and some of the information is out of date.
 
A few months ago, I started working on a new documentation solution based on the DocC documentation framework. This provides an easy way to add and edit documentation through markdown files. I have already ported a large section of Trac, all of the GitHub Wiki, and all of the non third party markdown files in the code over to this platform. I have tested this on macOS and Linux and have found it works extremely well. (Windows should be able to use WSL2 at the moment, while a few remaining issues get sorted out). The only dependency for this project is a recent installation of Swift.
 
You can already download the documentation and preview it locally, but we are looking to publish it online for easy viewing. We were looking to get your feedback if we would want to publish the documentation on GitHub Pages or webkit.org.
 
The documentation source can be found at https://github.com/webkit/documentation.
 
- Brandon
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

H,
It has been more than 5 months since this new documentation repository was announced and as far as I know it hasn't been published yet. Is there any news when this site will be publicly available?
Right now in Igalia we need to publish some information publicly and we were discussing where it's the right place to put it.
  * WebKit Documentation (https://github.com/webkit/documentation.git),
 IMHO it doesn't make sense because the information needs to be public.
  * Trac (https://trac.webkit.org/wiki),
 since WebKit Documentation hasn't been published yet, the fact is that we have been updating Trac pages in the last months.
  * WebKit GitHub Wiki (https://github.com/WebKit/WebKit/wiki),
 it seems like the best candidate. It says that new documentation should live there instead of being added to Trac. But on the other hand when WebKit Documentation was announced some people advocated for keep using the GH Wiki but that idea was discarded. It
 seems like WebKit GitHub Wiki is were new documents should be published until WebKit Documentation site is not available? Please confirm whether this assumption is correct or not.
--
Diego

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev



 

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev


 




___webkit-dev mailing listwebkit-dev@lists.webkit.orghttps://lists.webkit.org/mailman/listinfo/webkit-dev___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Kirsling, Ross via webkit-dev]

I’d vote for (1) since it’s easy to type!

Thanks,
Ross

From: Ryosuke Niwa via webkit-dev 
Reply-To: Ryosuke Niwa 
Date: Friday, March 10, 2023 at 6:41 AM
To: Brandon Stewart 
Cc: Ling Ho via webkit-dev 
Subject: Re: [webkit-dev] WebKit Documentation




On Mar 9, 2023, at 10:48 AM, Brandon Stewart via webkit-dev 
 wrote:

Sorry for the delay on the documentation update.

For getting the documentation system online, we were trying to settle on a 
subdomain.

What would people prefer we use as the official documentation location:
(1) docs.webkit.org
(2) developer.webkit.org
(3) documentation.webkit.org

(1) or (3) seems good.

- R. Niwa

On Feb 28, 2023, at 12:39 AM, dpino via webkit-dev 
 wrote:

On 9/20/22 05:28, Brandon Stewart via webkit-dev wrote:

Hi WebKit Developers,



Documentation is an important part of any open source project, especially for a 
larger project like WebKit. Being able to ramp up during the onboarding 
process, reading up on architectural decisions, and learning how to perform 
common procedures are all features the documentation should tackle. WebKit has 
a large set of documentation already, but it is scattered around a wide range 
of platforms (Trac, GitHub Wiki, markdown files in the code, Git commits, 
etc...), and some of the information is out of date.



A few months ago, I started working on a new documentation solution based on 
the DocC documentation framework. This provides an easy way to add and edit 
documentation through markdown files. I have already ported a large section of 
Trac, all of the GitHub Wiki, and all of the non third party markdown files in 
the code over to this platform. I have tested this on macOS and Linux and have 
found it works extremely well. (Windows should be able to use WSL2 at the 
moment, while a few remaining issues get sorted out). The only dependency for 
this project is a recent installation of Swift.



You can already download the documentation and preview it locally, but we are 
looking to publish it online for easy viewing. We were looking to get your 
feedback if we would want to publish the documentation on GitHub Pages or 
webkit.org.



The documentation source can be found at 
https://github.com/webkit/documentation<https://github.com/webkit/documentation>.



- Brandon

___

webkit-dev mailing list

webkit-dev@lists.webkit.org<mailto:webkit-dev@lists.webkit.org>

https://lists.webkit.org/mailman/listinfo/webkit-dev<https://lists.webkit.org/mailman/listinfo/webkit-dev>

H,

It has been more than 5 months since this new documentation repository was 
announced and as far as I know it hasn't been published yet. Is there any news 
when this site will be publicly available?

Right now in Igalia we need to publish some information publicly and we were 
discussing where it's the right place to put it.

  * WebKit Documentation 
(https://github.com/webkit/documentation.git<https://github.com/webkit/documentation.git>),
 IMHO it doesn't make sense because the information needs to be public.

  * Trac (https://trac.webkit.org/wiki<https://trac.webkit.org/wiki>), since 
WebKit Documentation hasn't been published yet, the fact is that we have been 
updating Trac pages in the last months.

  * WebKit GitHub Wiki 
(https://github.com/WebKit/WebKit/wiki<https://github.com/WebKit/WebKit/wiki>), 
it seems like the best candidate. It says that new documentation should live 
there instead of being added to Trac. But on the other hand when WebKit 
Documentation was announced some people advocated for keep using the GH Wiki 
but that idea was discarded. It seems like WebKit GitHub Wiki is were new 
documents should be published until WebKit Documentation site is not available? 
Please confirm whether this assumption is correct or not.

--

Diego
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev<https://lists.webkit.org/mailman/listinfo/webkit-dev>

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev<https://lists.webkit.org/mailman/listinfo/webkit-dev>

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Ryosuke Niwa via webkit-dev]

> On Mar 9, 2023, at 10:48 AM, Brandon Stewart via webkit-dev 
>  wrote:
> 
> Sorry for the delay on the documentation update.
> 
> For getting the documentation system online, we were trying to settle on a 
> subdomain.
> 
> What would people prefer we use as the official documentation location:
> (1) docs.webkit.org
> (2) developer.webkit.org
> (3) documentation.webkit.org

(1) or (3) seems good.

- R. Niwa

>> On Feb 28, 2023, at 12:39 AM, dpino via webkit-dev 
>>  wrote:
>> On 9/20/22 05:28, Brandon Stewart via webkit-dev wrote:
>> 
>>> Hi WebKit Developers,
>>> 
>>> Documentation is an important part of any open source project, especially 
>>> for a larger project like WebKit. Being able to ramp up during the 
>>> onboarding process, reading up on architectural decisions, and learning how 
>>> to perform common procedures are all features the documentation should 
>>> tackle. WebKit has a large set of documentation already, but it is 
>>> scattered around a wide range of platforms (Trac, GitHub Wiki, markdown 
>>> files in the code, Git commits, etc...), and some of the information is out 
>>> of date.
>>> 
>>> A few months ago, I started working on a new documentation solution based 
>>> on the DocC documentation framework. This provides an easy way to add and 
>>> edit documentation through markdown files. I have already ported a large 
>>> section of Trac, all of the GitHub Wiki, and all of the non third party 
>>> markdown files in the code over to this platform. I have tested this on 
>>> macOS and Linux and have found it works extremely well. (Windows should be 
>>> able to use WSL2 at the moment, while a few remaining issues get sorted 
>>> out). The only dependency for this project is a recent installation of 
>>> Swift.
>>> 
>>> You can already download the documentation and preview it locally, but we 
>>> are looking to publish it online for easy viewing. We were looking to get 
>>> your feedback if we would want to publish the documentation on GitHub Pages 
>>> or webkit.org.
>>> 
>>> The documentation source can be found at 
>>> https://github.com/webkit/documentation.
>>> 
>>> - Brandon
>>> ___
>>> webkit-dev mailing list
>>> webkit-dev@lists.webkit.org 
>>> https://lists.webkit.org/mailman/listinfo/webkit-dev
>> H,
>> 
>> It has been more than 5 months since this new documentation repository was 
>> announced and as far as I know it hasn't been published yet. Is there any 
>> news when this site will be publicly available?
>> 
>> Right now in Igalia we need to publish some information publicly and we were 
>> discussing where it's the right place to put it.
>> 
>>   * WebKit Documentation (https://github.com/webkit/documentation.git), IMHO 
>> it doesn't make sense because the information needs to be public.
>> 
>>   * Trac (https://trac.webkit.org/wiki), since WebKit Documentation hasn't 
>> been published yet, the fact is that we have been updating Trac pages in the 
>> last months.
>> 
>>   * WebKit GitHub Wiki (https://github.com/WebKit/WebKit/wiki), it seems 
>> like the best candidate. It says that new documentation should live there 
>> instead of being added to Trac. But on the other hand when WebKit 
>> Documentation was announced some people advocated for keep using the GH Wiki 
>> but that idea was discarded. It seems like WebKit GitHub Wiki is were new 
>> documents should be published until WebKit Documentation site is not 
>> available? Please confirm whether this assumption is correct or not.
>> 
>> --
>> 
>> Diego
>> 
>> ___
>> webkit-dev mailing list
>> webkit-dev@lists.webkit.org
>> https://lists.webkit.org/mailman/listinfo/webkit-dev
> 
> ___
> webkit-dev mailing list
> webkit-dev@lists.webkit.org
> https://lists.webkit.org/mailman/listinfo/webkit-dev

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

[webkit-dev] WebKit Documentation using MkDocs

[Brandon Stewart via webkit-dev]

Hello,

I got feedback that people would prefer not to add Swift as a requirement for 
building the documentation. Since WebKit relies heavily on Python for large 
parts of its tooling, I decided to port it over to a popular Python 
documentation system MkDocs.

This provides a few benefits over the previous solution:
- Improved search across documents
- Python based
- Easier to setup and install (just run pip3 install mkdocs-material)
- Works great across macOS, Linux, and Windows

The repo is located at the same location: 
https://github.com/WebKit/Documentation

I have been continuing to port over a large amount of the relevant 
documentation from Trac, but if you notice anything missing please feel free to 
add it.

Feedback welcome.

Thanks,
Brandon___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Brandon Stewart via webkit-dev]

Hello,

Sorry for the delay on the documentation update.

For getting the documentation system online, we were trying to settle on a 
subdomain.

What would people prefer we use as the official documentation location:
(1) docs.webkit.org
(2) developer.webkit.org
(3) documentation.webkit.org
(4) Other

Could you please reply to this e-mail indicating which origin you would prefer?

Thanks,
Brandon

> On Feb 28, 2023, at 12:39 AM, dpino via webkit-dev 
>  wrote:
> 
> 
> 
> On 9/20/22 05:28, Brandon Stewart via webkit-dev wrote:
>> Hi WebKit Developers,
>> 
>> Documentation is an important part of any open source project, especially 
>> for a larger project like WebKit. Being able to ramp up during the 
>> onboarding process, reading up on architectural decisions, and learning how 
>> to perform common procedures are all features the documentation should 
>> tackle. WebKit has a large set of documentation already, but it is scattered 
>> around a wide range of platforms (Trac, GitHub Wiki, markdown files in the 
>> code, Git commits, etc...), and some of the information is out of date.
>> 
>> A few months ago, I started working on a new documentation solution based on 
>> the DocC documentation framework. This provides an easy way to add and edit 
>> documentation through markdown files. I have already ported a large section 
>> of Trac, all of the GitHub Wiki, and all of the non third party markdown 
>> files in the code over to this platform. I have tested this on macOS and 
>> Linux and have found it works extremely well. (Windows should be able to use 
>> WSL2 at the moment, while a few remaining issues get sorted out). The only 
>> dependency for this project is a recent installation of Swift.
>> 
>> You can already download the documentation and preview it locally, but we 
>> are looking to publish it online for easy viewing. We were looking to get 
>> your feedback if we would want to publish the documentation on GitHub Pages 
>> or webkit.org.
>> 
>> The documentation source can be found at 
>> https://github.com/webkit/documentation.
>> 
>> - Brandon
>> ___
>> webkit-dev mailing list
>> webkit-dev@lists.webkit.org 
>> https://lists.webkit.org/mailman/listinfo/webkit-dev
> H,
> 
> It has been more than 5 months since this new documentation repository was 
> announced and as far as I know it hasn't been published yet. Is there any 
> news when this site will be publicly available?
> 
> Right now in Igalia we need to publish some information publicly and we were 
> discussing where it's the right place to put it.
> 
>   * WebKit Documentation (https://github.com/webkit/documentation.git), IMHO 
> it doesn't make sense because the information needs to be public.
> 
>   * Trac (https://trac.webkit.org/wiki), since WebKit Documentation hasn't 
> been published yet, the fact is that we have been updating Trac pages in the 
> last months.
> 
>   * WebKit GitHub Wiki (https://github.com/WebKit/WebKit/wiki), it seems like 
> the best candidate. It says that new documentation should live there instead 
> of being added to Trac. But on the other hand when WebKit Documentation was 
> announced some people advocated for keep using the GH Wiki but that idea was 
> discarded. It seems like WebKit GitHub Wiki is were new documents should be 
> published until WebKit Documentation site is not available? Please confirm 
> whether this assumption is correct or not.
> 
> --
> 
> Diego
> 
> ___
> webkit-dev mailing list
> webkit-dev@lists.webkit.org
> https://lists.webkit.org/mailman/listinfo/webkit-dev

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[dpino via webkit-dev]

On 9/20/22 05:28, Brandon Stewart via webkit-dev wrote: 

> Hi WebKit Developers,
> 
> Documentation is an important part of any open source project, especially for 
> a larger project like WebKit. Being able to ramp up during the onboarding 
> process, reading up on architectural decisions, and learning how to perform 
> common procedures are all features the documentation should tackle. WebKit 
> has a large set of documentation already, but it is scattered around a wide 
> range of platforms (Trac, GitHub Wiki, markdown files in the code, Git 
> commits, etc...), and some of the information is out of date.
> 
> A few months ago, I started working on a new documentation solution based on 
> the DocC documentation framework. This provides an easy way to add and edit 
> documentation through markdown files. I have already ported a large section 
> of Trac, all of the GitHub Wiki, and all of the non third party markdown 
> files in the code over to this platform. I have tested this on macOS and 
> Linux and have found it works extremely well. (Windows should be able to use 
> WSL2 at the moment, while a few remaining issues get sorted out). The only 
> dependency for this project is a recent installation of Swift.
> 
> You can already download the documentation and preview it locally, but we are 
> looking to publish it online for easy viewing. We were looking to get your 
> feedback if we would want to publish the documentation on GitHub Pages or 
> webkit.org.
> 
> The documentation source can be found at 
> https://github.com/webkit/documentation.
> 
> - Brandon
> ___
> webkit-dev mailing list
> webkit-dev@lists.webkit.org
> https://lists.webkit.org/mailman/listinfo/webkit-dev

H, 

It has been more than 5 months since this new documentation repository
was announced and as far as I know it hasn't been published yet. Is
there any news when this site will be publicly available? 

Right now in Igalia we need to publish some information publicly and we
were discussing where it's the right place to put it. 

  * WebKit Documentation (https://github.com/webkit/documentation.git),
IMHO it doesn't make sense because the information needs to be public. 

  * Trac (https://trac.webkit.org/wiki), since WebKit Documentation
hasn't been published yet, the fact is that we have been updating Trac
pages in the last months. 

  * WebKit GitHub Wiki (https://github.com/WebKit/WebKit/wiki), it seems
like the best candidate. It says that new documentation should live
there instead of being added to Trac. But on the other hand when WebKit
Documentation was announced some people advocated for keep using the GH
Wiki but that idea was discarded. It seems like WebKit GitHub Wiki is
were new documents should be published until WebKit Documentation site
is not available? Please confirm whether this assumption is correct or
not. 

-- 

Diego___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Ryosuke Niwa via webkit-dev]

> On Sep 21, 2022, at 6:50 AM, Michael Catanzaro  wrote:
> 
> On Tue, Sep 20 2022 at 08:03:12 PM -0700, Ryosuke Niwa via webkit-dev 
>  wrote:
>> (2) is particularly important because many people who are new to WebKit 
>> often don´t know what they don´t know. This is why, for example, memory 
>> management section appears towards the beginning of the document and the 
>> information about adding IDL files is immediately followed by the discussion 
>> of JS wrapper lifecycles. With these information now split across multiple 
>> files, it´s easy for people to miss out on critical information. In the 
>> ideal world, people won´t be adding or editing IDL files before they 
>> understood how JS wrappers are managed because not knowing the latter is a 
>> sure way of introducing subtle GC bugs.
> 
> I didn't know any of this info about JS wrapper lifecycle until I read about 
> it in Introduction.md a couple months ago. It really does need to be very 
> prominent or developers won't find it. That said, I think we can find a way 
> to do this without keeping it all in one single page.

Yeah, I’m sure there are ways to make it prominent without putting all the 
information into a single md file. But we need to come up with a way to do that.

- R. Niwa

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Michael Catanzaro via webkit-dev]

On Tue, Sep 20 2022 at 08:03:12 PM -0700, Ryosuke Niwa via webkit-dev 
 wrote:
(2) is particularly important because many people who are new to 
WebKit often don’t know what they don’t know. This is why, for 
example, memory management section appears towards the beginning of 
the document and the information about adding IDL files is 
immediately followed by the discussion of JS wrapper lifecycles. With 
these information now split across multiple files, it’s easy for 
people to miss out on critical information. In the ideal world, 
people won’t be adding or editing IDL files before they understood 
how JS wrappers are managed because not knowing the latter is a sure 
way of introducing subtle GC bugs.


I didn't know any of this info about JS wrapper lifecycle until I read 
about it in Introduction.md a couple months ago. It really does need to 
be very prominent or developers won't find it. That said, I think we 
can find a way to do this without keeping it all in one single page.



___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Ryosuke Niwa via webkit-dev]

> On Sep 20, 2022, at 1:52 PM, Brent Fulgham  wrote:
> 
>> On Sep 20, 2022, at 1:16 AM, Ryosuke Niwa via webkit-dev 
>>  wrote:
>> 
>>> On Sep 19, 2022, at 2:28 PM, Brandon Stewart via webkit-dev 
>>> mailto:webkit-dev@lists.webkit.org>> wrote:
>>> 
>>> Documentation is an important part of any open source project, especially 
>>> for a larger project like WebKit. Being able to ramp up during the 
>>> onboarding process, reading up on architectural decisions, and learning how 
>>> to perform common procedures are all features the documentation should 
>>> tackle. WebKit has a large set of documentation already, but it is 
>>> scattered around a wide range of platforms (Trac, GitHub Wiki, markdown 
>>> files in the code, Git commits, etc...), and some of the information is out 
>>> of date.
>> 
>> This ultimately feels like this situation:
>> https://xkcd.com/927/ 
>> 
>> I’ve been working on 
>> https://github.com/WebKit/WebKit/blob/main/Introduction.md 
>>  for the past 
>> couple of years, and I’d would have preferred to have a collaboration rather 
>> than a competition here.
> 
> Ryosuke: Your document is outstanding, and is a large part of the content we 
> pulled into the current repo. I don’t think we view this as a competition; 
> rather we are trying to host a collection of Markdown content in a common 
> repo that does not have to be pulled and synced with WebKit source and tests. 
> This provides a lower bar for people interested in contributing documentation 
> as they do not have to download and sync Gigabytes of WebKit code to write 
> documentation.

Who are these people who want to contribute to WebKit’s documentation yet 
doesn’t already have a clone of WebKit repository? I just can’t think of people 
who would fit that description.

There was a reason behind why the entire Introduction.md was written as a 
single markdown file though. Namely:
Reader can look up unknown terms right away in the same page using browsers’ 
find feature
Let reader be aware of things they are unaware of.

(2) is particularly important because many people who are new to WebKit often 
don’t know what they don’t know. This is why, for example, memory management 
section appears towards the beginning of the document and the information about 
adding IDL files is immediately followed by the discussion of JS wrapper 
lifecycles. With these information now split across multiple files, it’s easy 
for people to miss out on critical information. In the ideal world, people 
won’t be adding or editing IDL files before they understood how JS wrappers are 
managed because not knowing the latter is a sure way of introducing subtle GC 
bugs.

>>> A few months ago, I started working on a new documentation solution based 
>>> on the DocC documentation framework.
>> 
>> Was there any discussion as to which documentation framework should be used? 
>> I’m personally not familiar with DooC documentation, and I’m  surprised that 
>> such an important decision was made unilaterally without much discussion on 
>> webkit-dev.
> 
> We discussed this internally, but today’s message is the first discussion on 
> this repository that we’ve opened on the webkit-dev mailing list. We wanted 
> to convince ourselves that the tool worked well, and was easy to use, and 
> could produce documentation output that would be useful for Apple engineers. 
> That is not the only intended audience for this work, but is the origin of 
> this effort which we wanted to make available to others to use and contribute 
> to.
> 
> Those of us who have worked on WebKit for some time can easily remember the 
> many discussions over the years about documentation efforts of various types. 
> Lots of people have strong opinions, but few ever contribute despite their 
> opinions of the right way for the work to be done. You are obviously part of 
> the group that has contributed heavily, so I am sad that you do not seem to 
> like our approach.

Right, it’s why I wrote Introduction.md in the first place.

>>> I have already ported a large section of Trac, all of the GitHub Wiki, and 
>>> all of the non third party markdown files in the code over to this platform.
>> 
>> I’m not certain if there is a community wide support that this is the right 
>> tool to migrate all our documentations. I for one certainly object to the 
>> use of DooC as the primary documentation tool.
> 
> DocC is one way of processing the Markdown content in this repo, and one that 
> works well with Xcode since it creates output that matches Apple 
> documentation style, and an output archive that can be consumed and used 
> within Xcode search features.
> 
> There is nothing stopping an interested party using any of the other 
> available Markdown-to-HTML tools to process the data in a way they prefer, 
> much like WebKit sources can be built by Xcode, Visual Studio, and Make.

Okay but then which variant of mar

Re: [webkit-dev] WebKit Documentation

[Brent Fulgham via webkit-dev]

> On Sep 20, 2022, at 1:16 AM, Ryosuke Niwa via webkit-dev 
>  wrote:
> 
> 
>> On Sep 19, 2022, at 2:28 PM, Brandon Stewart via webkit-dev 
>> mailto:webkit-dev@lists.webkit.org>> wrote:
>> 
>> Documentation is an important part of any open source project, especially 
>> for a larger project like WebKit. Being able to ramp up during the 
>> onboarding process, reading up on architectural decisions, and learning how 
>> to perform common procedures are all features the documentation should 
>> tackle. WebKit has a large set of documentation already, but it is scattered 
>> around a wide range of platforms (Trac, GitHub Wiki, markdown files in the 
>> code, Git commits, etc...), and some of the information is out of date.
> 
> This ultimately feels like this situation:
> https://xkcd.com/927/
> 
> I’ve been working on 
> https://github.com/WebKit/WebKit/blob/main/Introduction.md for the past 
> couple of years, and I’d would have preferred to have a collaboration rather 
> than a competition here.

Ryosuke: Your document is outstanding, and is a large part of the content we 
pulled into the current repo. I don’t think we view this as a competition; 
rather we are trying to host a collection of Markdown content in a common repo 
that does not have to be pulled and synced with WebKit source and tests. This 
provides a lower bar for people interested in contributing documentation as 
they do not have to download and sync Gigabytes of WebKit code to write 
documentation.
> 
>> A few months ago, I started working on a new documentation solution based on 
>> the DocC documentation framework.
> 
> Was there any discussion as to which documentation framework should be used? 
> I’m personally not familiar with DooC documentation, and I’m  surprised that 
> such an important decision was made unilaterally without much discussion on 
> webkit-dev.

We discussed this internally, but today’s message is the first discussion on 
this repository that we’ve opened on the webkit-dev mailing list. We wanted to 
convince ourselves that the tool worked well, and was easy to use, and could 
produce documentation output that would be useful for Apple engineers. That is 
not the only intended audience for this work, but is the origin of this effort 
which we wanted to make available to others to use and contribute to.

Those of us who have worked on WebKit for some time can easily remember the 
many discussions over the years about documentation efforts of various types. 
Lots of people have strong opinions, but few ever contribute despite their 
opinions of the right way for the work to be done. You are obviously part of 
the group that has contributed heavily, so I am sad that you do not seem to 
like our approach.

> 
>> I have already ported a large section of Trac, all of the GitHub Wiki, and 
>> all of the non third party markdown files in the code over to this platform.
> 
> I’m not certain if there is a community wide support that this is the right 
> tool to migrate all our documentations. I for one certainly object to the use 
> of DooC as the primary documentation tool.

DocC is one way of processing the Markdown content in this repo, and one that 
works well with Xcode since it creates output that matches Apple documentation 
style, and an output archive that can be consumed and used within Xcode search 
features.

There is nothing stopping an interested party using any of the other available 
Markdown-to-HTML tools to process the data in a way they prefer, much like 
WebKit sources can be built by Xcode, Visual Studio, and Make.


>> I have tested this on macOS and Linux and have found it works extremely 
>> well. (Windows should be able to use WSL2 at the moment, while a few 
>> remaining issues get sorted out). The only dependency for this project is a 
>> recent installation of Swift.
> 
> Previously, we’ve rejected Swift as a general purpose programming languages 
> in WebKit: 
> https://lists.webkit.org/pipermail/webkit-dev/2014-July/026722.html other 
> than to allow existing C++ code to call into Swift API: 
> https://lists.webkit.org/pipermail/webkit-dev/2021-June/031882.html
> 
> As such, I don’t think we should require having a functional Swift toolchain 
> as a requirement for contributing to WebKit or its documentations either.

DocC is not a requirement to use or participate in this work. It’s simply a 
“port” of the documentation that works for our needs. If others prefer to 
“build” output documentation from Markdown using a different tool set, they are 
welcome to contribute those build commands and instructions.

Our goal is to accumulate all relevant and open source documentation related to 
WebKit in this repository so that we can generate searchable documentation. We 
would also like this to be accessible and searchable from the web.

Thanks,

-Brent

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit

Re: [webkit-dev] WebKit Documentation

[Ryosuke Niwa via webkit-dev]

> On Sep 20, 2022, at 6:04 AM, Michael Catanzaro  wrote:
> 
> On Tue, Sep 20 2022 at 01:16:53 AM -0700, Ryosuke Niwa via webkit-dev 
>  wrote:
>> I´ve been working on 
>> https://github.com/WebKit/WebKit/blob/main/Introduction.md for the past 
>> couple of years, and I´d would have preferred to have a collaboration rather 
>> than a competition here.
> 
> This Introduction.md is great work (I've learned a lot from it), but it's 
> also getting pretty long for a single document. At least, it significantly 
> exceeds my attention span. We could present this same info better if we split 
> it into multiple pages.

Yeah, I agree. I wanted to keep the document searchable; putting them all in a 
single document lets us use browser’s “find” function. GitHub wiki pages are 
searchable so splitting into multiple pages isn’t an issue there.

- R. Niwa

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Michael Catanzaro via webkit-dev]

On Tue, Sep 20 2022 at 01:16:53 AM -0700, Ryosuke Niwa via webkit-dev 
 wrote:
I’ve been working on 
https://github.com/WebKit/WebKit/blob/main/Introduction.md for the 
past couple of years, and I’d would have preferred to have a 
collaboration rather than a competition here.


This Introduction.md is great work (I've learned a lot from it), but 
it's also getting pretty long for a single document. At least, it 
significantly exceeds my attention span. We could present this same 
info better if we split it into multiple pages.



___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Konstantin Tokarev via webkit-dev]

> Why not double-down on the GitHub wiki? It's very easy to learn to use,
> and there are edit buttons everywhere so there is no "distance" between
> the docs and the ability to edit them. The easier it is to edit docs,
> the better we'll do at keeping them up to date.
> 
> I like Markdown, and am OK with editing Markdown files wherever they
> live, but it's not very likely that I would install Swift and figure
> out how to build a new project to to see what the result looks like.
> With GitHub, we can easily preview results live to ensure we're not
> messing anything up.

Also, Markdown is not the only format supported by GitHub. It's also possible to
use AsciiDoc, POD, reStructuredText, or any other format listed in [1] in any
file of main repository or in wiki, and it will be rendered to HTML when 
browsing
online.

[1] https://github.com/github/markup/blob/master/README.md#markups

-- Regards,
Konstantin
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Ryosuke Niwa via webkit-dev]

> On Sep 19, 2022, at 2:58 PM, Michael Catanzaro via webkit-dev 
>  wrote:
> 
> Why not double-down on the GitHub wiki? It's very easy to learn to use, and 
> there are edit buttons everywhere so there is no "distance" between the docs 
> and the ability to edit them. The easier it is to edit docs, the better we'll 
> do at keeping them up to date.

One drawback of wiki is that changes won’t be code reviewed. I find that the 
much of the existing WebKit documentations are filled with outdated, 
inaccurate, and/or incomplete information, and a part of the reason is because 
no formal review is done unlike our code. At least in my experience working on 
https://github.com/WebKit/WebKit/blob/main/Introduction.md 
, I find that code 
review to be generally helpful.

> I like Markdown, and am OK with editing Markdown files wherever they live, 
> but it's not very likely that I would install Swift and figure out how to 
> build a new project to to see what the result looks like. With GitHub, we can 
> easily preview results live to ensure we're not messing anything up.

I totally agree. In order for this new documentation effort to be successful, 
contribution needs be as simple & straight forward as possible.

- R. Niwa

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Ryosuke Niwa via webkit-dev]

> On Sep 19, 2022, at 2:28 PM, Brandon Stewart via webkit-dev 
>  wrote:
> 
> Documentation is an important part of any open source project, especially for 
> a larger project like WebKit. Being able to ramp up during the onboarding 
> process, reading up on architectural decisions, and learning how to perform 
> common procedures are all features the documentation should tackle. WebKit 
> has a large set of documentation already, but it is scattered around a wide 
> range of platforms (Trac, GitHub Wiki, markdown files in the code, Git 
> commits, etc...), and some of the information is out of date.

This ultimately feels like this situation:
https://xkcd.com/927/ 

I’ve been working on https://github.com/WebKit/WebKit/blob/main/Introduction.md 
 for the past 
couple of years, and I’d would have preferred to have a collaboration rather 
than a competition here.

> A few months ago, I started working on a new documentation solution based on 
> the DocC documentation framework.

Was there any discussion as to which documentation framework should be used? 
I’m personally not familiar with DooC documentation, and I’m  surprised that 
such an important decision was made unilaterally without much discussion on 
webkit-dev.

> I have already ported a large section of Trac, all of the GitHub Wiki, and 
> all of the non third party markdown files in the code over to this platform.

I’m not certain if there is a community wide support that this is the right 
tool to migrate all our documentations. I for one certainly object to the use 
of DooC as the primary documentation tool.

> I have tested this on macOS and Linux and have found it works extremely well. 
> (Windows should be able to use WSL2 at the moment, while a few remaining 
> issues get sorted out). The only dependency for this project is a recent 
> installation of Swift.

Previously, we’ve rejected Swift as a general purpose programming languages in 
WebKit: https://lists.webkit.org/pipermail/webkit-dev/2014-July/026722.html 
 other 
than to allow existing C++ code to call into Swift API: 
https://lists.webkit.org/pipermail/webkit-dev/2021-June/031882.html 


As such, I don’t think we should require having a functional Swift toolchain as 
a requirement for contributing to WebKit or its documentations either.

- R. Niwa

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Ryosuke Niwa via webkit-dev]

> On Sep 19, 2022, at 4:48 PM, Fujii Hironori via webkit-dev 
>  wrote:
> 
> Why not double-down on WebKit Git repository?
> The closer the document is to the source code, the easier to keep them 
> up-to-date.
> We can modify both the source code and the document in a single commit 
> through our review process.

The fact documentation is separated from code is a feature, not a bug. We don't 
want to make updating documentation a contribution requirement. Just like unit 
tests, this sort of thing can significantly hinder our willingness and 
capabilities to do large scale refactoring, renames, etc...

- R. Niwa

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Ling Ho via webkit-dev]

On 9/19/22 4:48 PM, Fujii Hironori via webkit-dev wrote:

Why not double-down on WebKit Git repository?
The closer the document is to the source code, the easier to keep them 
up-to-date.
We can modify both the source code and the document in a single commit 
through our review process.


Do you plan to shutdown https://trac.webkit.org/wiki ?
There is no immediate plan to shut down https://trac.webkit.org/wiki as 
long as there is a need. However, keeping another system with separate 
set of credentials is not ideal especially they are no longer needed for 
SVN.


...
ling




___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Fujii Hironori via webkit-dev]

Why not double-down on WebKit Git repository?
The closer the document is to the source code, the easier to keep them
up-to-date.
We can modify both the source code and the document in a single commit
through our review process.

Do you plan to shutdown https://trac.webkit.org/wiki ?
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] WebKit Documentation

[Michael Catanzaro via webkit-dev]

Why not double-down on the GitHub wiki? It's very easy to learn to use, 
and there are edit buttons everywhere so there is no "distance" between 
the docs and the ability to edit them. The easier it is to edit docs, 
the better we'll do at keeping them up to date.


I like Markdown, and am OK with editing Markdown files wherever they 
live, but it's not very likely that I would install Swift and figure 
out how to build a new project to to see what the result looks like. 
With GitHub, we can easily preview results live to ensure we're not 
messing anything up.


Michael


___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

[webkit-dev] WebKit Documentation

[Brandon Stewart via webkit-dev]

Hi WebKit Developers,

Documentation is an important part of any open source project, especially for a 
larger project like WebKit. Being able to ramp up during the onboarding 
process, reading up on architectural decisions, and learning how to perform 
common procedures are all features the documentation should tackle. WebKit has 
a large set of documentation already, but it is scattered around a wide range 
of platforms (Trac, GitHub Wiki, markdown files in the code, Git commits, 
etc...), and some of the information is out of date.

A few months ago, I started working on a new documentation solution based on 
the DocC documentation framework. This provides an easy way to add and edit 
documentation through markdown files. I have already ported a large section of 
Trac, all of the GitHub Wiki, and all of the non third party markdown files in 
the code over to this platform. I have tested this on macOS and Linux and have 
found it works extremely well. (Windows should be able to use WSL2 at the 
moment, while a few remaining issues get sorted out). The only dependency for 
this project is a recent installation of Swift.

You can already download the documentation and preview it locally, but we are 
looking to publish it online for easy viewing. We were looking to get your 
feedback if we would want to publish the documentation on GitHub Pages or 
webkit.org.

The documentation source can be found at 
https://github.com/webkit/documentation.

- Brandon
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-dev

Re: [webkit-dev] webkit documentation

[Jack Wootton]

Thanks. I finally managed to download the source by using a different
computer. As a result I have created a patch file and updated the bug.
 I will have to check, but can only assume that although I had admin
rights, I was logged in as a user not 'Administrator'.  Maybe this
caused a problem when downloading the source using cygwin.

On Sat, Nov 22, 2008 at 11:28 AM, William Siegrist <[EMAIL PROTECTED]> wrote:
> You can get a tarball of a working copy here:
>
> http://builds.nightly.webkit.org/files/trunk/src/WebKit-r38688.tar.bz2
>
> -Bill
>
>
> On Nov 22, 2008, at 1:05 AM, Jack Wootton wrote:
>
>> I am unable to download src because of the SVN error "Could not read
>> response body: connection was closed by server", which I have
>> attempted to resolve many times through the help of people on this
>> mailing list, but it remains unresolved.  I think the only way forward
>> is to revert to resolving that problem before the website can be
>> updated with documentation information.
>>
>> On Fri, Nov 21, 2008 at 7:13 PM, David Kilzer <[EMAIL PROTECTED]> wrote:
>>>
>>> Jack,
>>> You did not create a patch to the actual HTML file that you wanted to
>>> change.  You simply attached a text file with a description of the link.
>>>  If
>>> you need help on how to create a patch or checkout the "source" for the
>>> web
>>> site, please ask.
>>> Dave
>>>
>>> ____
>>> From: Jack Wootton <[EMAIL PROTECTED]>
>>> To: [EMAIL PROTECTED]
>>> Cc: webkit-dev@lists.webkit.org
>>> Sent: Friday, November 21, 2008 8:25:32 AM
>>> Subject: Re: [webkit-dev] webkit documentation
>>>
>>> I have done this, but it was rejected:
>>>
>>> https://bugs.webkit.org/show_bug.cgi?id=20125
>>>
>>> On Mon, Jul 21, 2008 at 3:22 PM, David Kilzer <[EMAIL PROTECTED]>
>>> wrote:
>>>>
>>>> We update the web site through patches.  Just file a bug on
>>>> bugs.webkit.org and attach a patch with ChangeLog for review!
>>>>
>>>> Dave
>>>>
>>>>
>>>> On Mon, 7/21/08, Jack Wootton <[EMAIL PROTECTED]> wrote:
>>>>
>>>>> OK, it seems this is a good place to start
>>>>>
>>>>>
>>>>>
>>>>> http://developer.apple.com/documentation/Cocoa/Conceptual/DisplayWebContent/Concepts/WebKitDesign.html
>>>>>
>>>>> Had to use Google to find it though, is it linked to on
>>>>> http://webkit.org/ at all?
>>>>>
>>>>> Cheers,
>>>>> Jack
>>>>>
>>>>> On Mon, Jul 21, 2008 at 9:57 AM, Jack Wootton
>>>>> <[EMAIL PROTECTED]> wrote:
>>>>>>
>>>>>> Hi all,
>>>>>>
>>>>>> I am mainly interested in S60 WebKit, however due to
>>>>>
>>>>> the project
>>>>>>
>>>>>> seeming to be in complete disarray to those not
>>>>>
>>>>> working for Nokia,
>>>>>>
>>>>>> I've decided to focus my efforts on the WebKit
>>>>>
>>>>> branch from which S60
>>>>>>
>>>>>> WebKit started. I understand this to be Tiger 10.4.7
>>>>>
>>>>> (it was one of
>>>>>>
>>>>>> the few pieces of information about S60 WebKit that I
>>>>>
>>>>> could actually
>>>>>>
>>>>>> find - although it will almost certainly turn out to
>>>>>
>>>>> be incorrect :p):
>>>>>>
>>>>>>
>>>>>
>>>>>
>>>>> http://trac.webkit.org/browser/releases/Apple/Tiger/Mac%20OS%20X%20Update%2010.4.7
>>>>>>
>>>>>> Where can I find documentation for this code?  The
>>>>>
>>>>> question here is,
>>>>>>
>>>>>> other than trawling through code, where can I find
>>>>>
>>>>> documentation that
>>>>>>
>>>>>> explain it's implementation?
>>>>>>
>>>>>> Cheers,
>>>>>> Jack
>>>>>>
>>>>>
>>>>
>>>>
>>>
>>>
>>>
>>> --
>>> Regards
>>> Jack
>>>
>>
>>
>>
>> --
>> Regards
>> Jack
>> ___
>> webkit-dev mailing list
>> webkit-dev@lists.webkit.org
>> http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev
>
>
>
>
> 
> William Siegrist
> Mac OS Forge
> http://macosforge.org/
>
>
>
>
>
>
>
>



-- 
Regards
Jack
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev

Re: [webkit-dev] webkit documentation

[William Siegrist]

You can get a tarball of a working copy here:

http://builds.nightly.webkit.org/files/trunk/src/WebKit-r38688.tar.bz2

-Bill


On Nov 22, 2008, at 1:05 AM, Jack Wootton wrote:


I am unable to download src because of the SVN error "Could not read
response body: connection was closed by server", which I have
attempted to resolve many times through the help of people on this
mailing list, but it remains unresolved.  I think the only way forward
is to revert to resolving that problem before the website can be
updated with documentation information.

On Fri, Nov 21, 2008 at 7:13 PM, David Kilzer <[EMAIL PROTECTED]>  
wrote:

Jack,
You did not create a patch to the actual HTML file that you wanted to
change.  You simply attached a text file with a description of the  
link.  If
you need help on how to create a patch or checkout the "source" for  
the web

site, please ask.
Dave


From: Jack Wootton <[EMAIL PROTECTED]>
To: [EMAIL PROTECTED]
Cc: webkit-dev@lists.webkit.org
Sent: Friday, November 21, 2008 8:25:32 AM
Subject: Re: [webkit-dev] webkit documentation

I have done this, but it was rejected:

https://bugs.webkit.org/show_bug.cgi?id=20125

On Mon, Jul 21, 2008 at 3:22 PM, David Kilzer <[EMAIL PROTECTED]>  
wrote:

We update the web site through patches.  Just file a bug on
bugs.webkit.org and attach a patch with ChangeLog for review!

Dave


On Mon, 7/21/08, Jack Wootton <[EMAIL PROTECTED]> wrote:


OK, it seems this is a good place to start


http://developer.apple.com/documentation/Cocoa/Conceptual/DisplayWebContent/Concepts/WebKitDesign.html

Had to use Google to find it though, is it linked to on
http://webkit.org/ at all?

Cheers,
Jack

On Mon, Jul 21, 2008 at 9:57 AM, Jack Wootton
<[EMAIL PROTECTED]> wrote:

Hi all,

I am mainly interested in S60 WebKit, however due to

the project

seeming to be in complete disarray to those not

working for Nokia,

I've decided to focus my efforts on the WebKit

branch from which S60

WebKit started. I understand this to be Tiger 10.4.7

(it was one of

the few pieces of information about S60 WebKit that I

could actually

find - although it will almost certainly turn out to

be incorrect :p):





http://trac.webkit.org/browser/releases/Apple/Tiger/Mac%20OS%20X%20Update%2010.4.7


Where can I find documentation for this code?  The

question here is,

other than trawling through code, where can I find

documentation that

explain it's implementation?

Cheers,
Jack










--
Regards
Jack





--
Regards
Jack
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev






William Siegrist
Mac OS Forge
http://macosforge.org/









smime.p7s
Description: S/MIME cryptographic signature
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev

Re: [webkit-dev] webkit documentation

[Jack Wootton]

I am unable to download src because of the SVN error "Could not read
response body: connection was closed by server", which I have
attempted to resolve many times through the help of people on this
mailing list, but it remains unresolved.  I think the only way forward
is to revert to resolving that problem before the website can be
updated with documentation information.

On Fri, Nov 21, 2008 at 7:13 PM, David Kilzer <[EMAIL PROTECTED]> wrote:
> Jack,
> You did not create a patch to the actual HTML file that you wanted to
> change.  You simply attached a text file with a description of the link.  If
> you need help on how to create a patch or checkout the "source" for the web
> site, please ask.
> Dave
>
> 
> From: Jack Wootton <[EMAIL PROTECTED]>
> To: [EMAIL PROTECTED]
> Cc: webkit-dev@lists.webkit.org
> Sent: Friday, November 21, 2008 8:25:32 AM
> Subject: Re: [webkit-dev] webkit documentation
>
> I have done this, but it was rejected:
>
> https://bugs.webkit.org/show_bug.cgi?id=20125
>
> On Mon, Jul 21, 2008 at 3:22 PM, David Kilzer <[EMAIL PROTECTED]> wrote:
>> We update the web site through patches.  Just file a bug on
>> bugs.webkit.org and attach a patch with ChangeLog for review!
>>
>> Dave
>>
>>
>> On Mon, 7/21/08, Jack Wootton <[EMAIL PROTECTED]> wrote:
>>
>>> OK, it seems this is a good place to start
>>>
>>>
>>> http://developer.apple.com/documentation/Cocoa/Conceptual/DisplayWebContent/Concepts/WebKitDesign.html
>>>
>>> Had to use Google to find it though, is it linked to on
>>> http://webkit.org/ at all?
>>>
>>> Cheers,
>>> Jack
>>>
>>> On Mon, Jul 21, 2008 at 9:57 AM, Jack Wootton
>>> <[EMAIL PROTECTED]> wrote:
>>> > Hi all,
>>> >
>>> > I am mainly interested in S60 WebKit, however due to
>>> the project
>>> > seeming to be in complete disarray to those not
>>> working for Nokia,
>>> > I've decided to focus my efforts on the WebKit
>>> branch from which S60
>>> > WebKit started. I understand this to be Tiger 10.4.7
>>> (it was one of
>>> > the few pieces of information about S60 WebKit that I
>>> could actually
>>> > find - although it will almost certainly turn out to
>>> be incorrect :p):
>>> >
>>> >
>>>
>>> http://trac.webkit.org/browser/releases/Apple/Tiger/Mac%20OS%20X%20Update%2010.4.7
>>> >
>>> > Where can I find documentation for this code?  The
>>> question here is,
>>> > other than trawling through code, where can I find
>>> documentation that
>>> > explain it's implementation?
>>> >
>>> > Cheers,
>>> > Jack
>>> >
>>>
>>
>>
>
>
>
> --
> Regards
> Jack
>



-- 
Regards
Jack
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev

Re: [webkit-dev] webkit documentation

[David Kilzer]

Jack,

You did not create a patch to the actual HTML file that you wanted to change.  
You simply attached a text file with a description of the link.  If you need 
help on how to create a patch or checkout the "source" for the web site, please 
ask.

Dave





From: Jack Wootton <[EMAIL PROTECTED]>
To: [EMAIL PROTECTED]
Cc: webkit-dev@lists.webkit.org
Sent: Friday, November 21, 2008 8:25:32 AM
Subject: Re: [webkit-dev] webkit documentation

I have done this, but it was rejected:

https://bugs.webkit.org/show_bug.cgi?id=20125

On Mon, Jul 21, 2008 at 3:22 PM, David Kilzer <[EMAIL PROTECTED]> wrote:
> We update the web site through patches.  Just file a bug on bugs.webkit.org 
> and attach a patch with ChangeLog for review!
>
> Dave
>
>
> On Mon, 7/21/08, Jack Wootton <[EMAIL PROTECTED]> wrote:
>
>> OK, it seems this is a good place to start
>>
>> http://developer.apple.com/documentation/Cocoa/Conceptual/DisplayWebContent/Concepts/WebKitDesign.html
>>
>> Had to use Google to find it though, is it linked to on
>> http://webkit.org/ at all?
>>
>> Cheers,
>> Jack
>>
>> On Mon, Jul 21, 2008 at 9:57 AM, Jack Wootton
>> <[EMAIL PROTECTED]> wrote:
>> > Hi all,
>> >
>> > I am mainly interested in S60 WebKit, however due to
>> the project
>> > seeming to be in complete disarray to those not
>> working for Nokia,
>> > I've decided to focus my efforts on the WebKit
>> branch from which S60
>> > WebKit started. I understand this to be Tiger 10.4.7
>> (it was one of
>> > the few pieces of information about S60 WebKit that I
>> could actually
>> > find - although it will almost certainly turn out to
>> be incorrect :p):
>> >
>> >
>> http://trac.webkit.org/browser/releases/Apple/Tiger/Mac%20OS%20X%20Update%2010.4.7
>> >
>> > Where can I find documentation for this code?  The
>> question here is,
>> > other than trawling through code, where can I find
>> documentation that
>> > explain it's implementation?
>> >
>> > Cheers,
>> > Jack
>> >
>>
>
>



-- 
Regards
Jack
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev

Re: [webkit-dev] webkit documentation

[Jack Wootton]

I have done this, but it was rejected:

https://bugs.webkit.org/show_bug.cgi?id=20125

On Mon, Jul 21, 2008 at 3:22 PM, David Kilzer <[EMAIL PROTECTED]> wrote:
> We update the web site through patches.  Just file a bug on bugs.webkit.org 
> and attach a patch with ChangeLog for review!
>
> Dave
>
>
> On Mon, 7/21/08, Jack Wootton <[EMAIL PROTECTED]> wrote:
>
>> OK, it seems this is a good place to start
>>
>> http://developer.apple.com/documentation/Cocoa/Conceptual/DisplayWebContent/Concepts/WebKitDesign.html
>>
>> Had to use Google to find it though, is it linked to on
>> http://webkit.org/ at all?
>>
>> Cheers,
>> Jack
>>
>> On Mon, Jul 21, 2008 at 9:57 AM, Jack Wootton
>> <[EMAIL PROTECTED]> wrote:
>> > Hi all,
>> >
>> > I am mainly interested in S60 WebKit, however due to
>> the project
>> > seeming to be in complete disarray to those not
>> working for Nokia,
>> > I've decided to focus my efforts on the WebKit
>> branch from which S60
>> > WebKit started. I understand this to be Tiger 10.4.7
>> (it was one of
>> > the few pieces of information about S60 WebKit that I
>> could actually
>> > find - although it will almost certainly turn out to
>> be incorrect :p):
>> >
>> >
>> http://trac.webkit.org/browser/releases/Apple/Tiger/Mac%20OS%20X%20Update%2010.4.7
>> >
>> > Where can I find documentation for this code?  The
>> question here is,
>> > other than trawling through code, where can I find
>> documentation that
>> > explain it's implementation?
>> >
>> > Cheers,
>> > Jack
>> >
>>
>
>



-- 
Regards
Jack
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev

Re: [webkit-dev] webkit documentation

[David Kilzer]

We update the web site through patches.  Just file a bug on bugs.webkit.org and 
attach a patch with ChangeLog for review!

Dave


On Mon, 7/21/08, Jack Wootton <[EMAIL PROTECTED]> wrote:

> OK, it seems this is a good place to start
> 
> http://developer.apple.com/documentation/Cocoa/Conceptual/DisplayWebContent/Concepts/WebKitDesign.html
> 
> Had to use Google to find it though, is it linked to on
> http://webkit.org/ at all?
> 
> Cheers,
> Jack
> 
> On Mon, Jul 21, 2008 at 9:57 AM, Jack Wootton
> <[EMAIL PROTECTED]> wrote:
> > Hi all,
> >
> > I am mainly interested in S60 WebKit, however due to
> the project
> > seeming to be in complete disarray to those not
> working for Nokia,
> > I've decided to focus my efforts on the WebKit
> branch from which S60
> > WebKit started. I understand this to be Tiger 10.4.7
> (it was one of
> > the few pieces of information about S60 WebKit that I
> could actually
> > find - although it will almost certainly turn out to
> be incorrect :p):
> >
> >
> http://trac.webkit.org/browser/releases/Apple/Tiger/Mac%20OS%20X%20Update%2010.4.7
> >
> > Where can I find documentation for this code?  The
> question here is,
> > other than trawling through code, where can I find
> documentation that
> > explain it's implementation?
> >
> > Cheers,
> > Jack
> >
> 

___
webkit-dev mailing list
webkit-dev@lists.webkit.org
http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev

Re: [webkit-dev] webkit documentation

[Jack Wootton]

OK, it seems this is a good place to start

http://developer.apple.com/documentation/Cocoa/Conceptual/DisplayWebContent/Concepts/WebKitDesign.html

Had to use Google to find it though, is it linked to on
http://webkit.org/ at all?

Cheers,
Jack

On Mon, Jul 21, 2008 at 9:57 AM, Jack Wootton <[EMAIL PROTECTED]> wrote:
> Hi all,
>
> I am mainly interested in S60 WebKit, however due to the project
> seeming to be in complete disarray to those not working for Nokia,
> I've decided to focus my efforts on the WebKit branch from which S60
> WebKit started. I understand this to be Tiger 10.4.7 (it was one of
> the few pieces of information about S60 WebKit that I could actually
> find - although it will almost certainly turn out to be incorrect :p):
>
> http://trac.webkit.org/browser/releases/Apple/Tiger/Mac%20OS%20X%20Update%2010.4.7
>
> Where can I find documentation for this code?  The question here is,
> other than trawling through code, where can I find documentation that
> explain it's implementation?
>
> Cheers,
> Jack
>



-- 
Regards
Jack
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev

[webkit-dev] webkit documentation

[Jack Wootton]

Hi all,

I am mainly interested in S60 WebKit, however due to the project
seeming to be in complete disarray to those not working for Nokia,
I've decided to focus my efforts on the WebKit branch from which S60
WebKit started. I understand this to be Tiger 10.4.7 (it was one of
the few pieces of information about S60 WebKit that I could actually
find - although it will almost certainly turn out to be incorrect :p):

http://trac.webkit.org/browser/releases/Apple/Tiger/Mac%20OS%20X%20Update%2010.4.7

Where can I find documentation for this code?  The question here is,
other than trawling through code, where can I find documentation that
explain it's implementation?

Cheers,
Jack
___
webkit-dev mailing list
webkit-dev@lists.webkit.org
http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev