[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [ft-devel] actually converting FreeType documentation to markdown
From: |
Werner LEMBERG |
Subject: |
Re: [ft-devel] actually converting FreeType documentation to markdown |
Date: |
Mon, 23 Jul 2018 08:32:23 +0200 (CEST) |
>> how shall we do the conversion of the API documentation (in the
>> header files) to markdown? What steps do you recommend?
>
> Once we convert the documentation to markdown, it will become
> incompatible with the current docmaker.
OK.
> I suggest the following:
>
> 1. Create a separate branch and push docwriter along with changes to
> the makefiles.
>
> 2. Convert documentation in the branch to markdown. Updates to the
> header files in master can continue normally.
>
> 3. Once this is tested and verified, we can revert changes to the
> header files, rebase new changes from master and reapply
> 'markify' before finally merging this branch to master.
>
> With these steps, the transition should be smooth.
OK, sounds sensible. Please proceed! This branch will be another
link in your final GSoC presentation :-)
Werner