Convert wiki to markdown #1234

drewwells · 2015-05-21T21:20:20Z

Work in progress converting all the local wiki articles to markdown files and linking them appropriately.

After this is complete, the wiki will link to https://github.com/sass/libsass/tree/master/docs

Check it out: https://github.com/drewwells/libsass/blob/feature/md/docs/README.md

Internals

coveralls · 2015-05-21T21:38:16Z

Coverage remained the same at 80.28% when pulling 75b54e6 on drewwells:feature/md into 221d7fb on sass:master.

ghost · 2015-05-26T17:45:54Z

Renaming docs to Documentation will stick the directory always on top (unless, of course, you have some directory like BAM which doesn't happen very often).

References:

drewwells · 2015-05-26T18:01:40Z

I'm not too worried about where this sits in sorting order since we'll be
linking to it from the README and wiki rather than hunting for it in the
source tree.

On Tue, May 26, 2015 at 12:45 PM, Peter Jas notifications@github.com
wrote:

Renaming docs to Documentation will stick the directory always on top
(unless, of course, you have some directory like BAM which doesn't happen
very often).

References:

https://github.com/torvalds/linux

https://github.com/dotnet/coreclr

https://github.com/dotnet/corefx

—
Reply to this email directly or view it on GitHub
#1234 (comment).

ghost · 2015-05-26T19:31:00Z

Nevertheless I suggested in the spirit of "better convention should go viral": keeping docs on top, then goes the rest of the repository assets. 🎌

drewwells · 2015-05-26T21:25:13Z

Linux uses text files, that's not something we should encourage to go viral
On Tue, May 26, 2015 at 2:31 PM Peter Jas notifications@github.com wrote:

Nevertheless I suggested in the spirit of "better convention should go
viral": keeping docs on top, then goes the rest of the repository assets. [image:
🎌]

—
Reply to this email directly or view it on GitHub
#1234 (comment).

xzyfer · 2015-05-26T21:53:02Z

We'll stick with docs. It's more node-y

drewwells · 2015-09-07T23:02:01Z

brought this back to life. Added tasks to show progress. We are close to getting this done!

xzyfer · 2015-09-07T23:13:10Z

😍

drewwells · 2015-09-18T16:36:38Z

Okay, this should cover all the pages I have. @xzyfer we probably want to get this in before the docs change for 3.3 :)

- doc index - makefile and autotools docs - convert local links to markdown - contributing and dev environment, triage, compat - function, context, importer, value, errors, unicode, others

drewwells · 2015-09-18T17:34:09Z

squashed to single commit

una · 2015-10-08T12:53:34Z

docs/README.md

+
+### Implementing libsass
+
+If you're interested in implementing libsass in your own project see the [API Documentation](api-doc.md) which now includes implementing 


Maybe keep the consistent naming convention of "LibsSass" > "libsass"

una · 2015-10-08T13:02:40Z

docs/api-doc.md

+
+## ABI forward compatibility
+
+We use a functional API to make dynamic linking more robust and future compatible. The API is not yet 100% stable, so we do not yet guarantee ABI forward compatibility. We will do so, once we increase the shared library version above 1.0.


Can you link to the API here so people can read up on it for further details if they find a problem?

una · 2015-10-08T13:28:39Z

The docs look good to me, just did a few copy edits/notes to watch out for 😄 thanks for doing this!

drewwells · 2015-10-08T13:31:59Z

Thanks for looking through these. I probably won't get to making these
changes for a while. You can send a PR to this branch and I'll merge it in
with this.

On Thu, Oct 8, 2015, 8:28 AM Una Kravets notifications@github.com wrote:

The docs look good to me, just did a few copy edits/notes to watch out for [image:
😄] thanks for doing this!

—
Reply to this email directly or view it on GitHub
#1234 (comment).

una · 2015-10-08T13:35:14Z

I'd be happy to!

charliepark · 2015-10-08T14:02:09Z

docs/README.md

+
+|   Issue Tracker   |            Issue Triage          |     Community Guidelines    |
+|-------------------|----------------------------------|-----------------------------|
+| We're always needing help, so checkout our issue tracker, help some people out, and read our article on [Contributing](contributing.md)! It's got all the details on what to do! | To help understand the process of triaging bugs, have a look at our [Issue-Triage](triage.md) document. | Oh, and don't forget we always follow [[Sass Community Guidelines|http://sass-lang.com/community-guidelines]]. Be nice and everyone else will be nice too! |


I think you want "check out" here.
http://grammarist.com/spelling/checkout-check-out/

copy edits, case changes, punctuation in docs

Convert wiki to markdown

drewwells force-pushed the feature/md branch 3 times, most recently from 6461788 to 6eec94b Compare September 7, 2015 22:03

drewwells changed the title ~~[DO NOT MERGE] Convert wiki to markdown~~ Convert wiki to markdown Sep 7, 2015

drewwells force-pushed the feature/md branch 7 times, most recently from 4842d2d to 0bfdcc6 Compare September 7, 2015 23:00

drewwells force-pushed the feature/md branch from 0ba948a to 50e7608 Compare September 18, 2015 16:35

Convert wiki to markdown

8676263

- doc index - makefile and autotools docs - convert local links to markdown - contributing and dev environment, triage, compat - function, context, importer, value, errors, unicode, others

drewwells force-pushed the feature/md branch from 50e7608 to 8676263 Compare September 18, 2015 17:33

xzyfer self-assigned this Sep 28, 2015

xzyfer added the Community label Sep 28, 2015

una reviewed Oct 8, 2015
View reviewed changes

charliepark reviewed Oct 8, 2015
View reviewed changes

UNA A. KRAVETS and others added 2 commits October 8, 2015 09:56

copy edits, case changes, punctuation in docs

be25ef9

Merge pull request #1 from una/feature/md

cd29efa

copy edits, case changes, punctuation in docs

xzyfer added this to the 3.3 milestone Oct 24, 2015

xzyfer added a commit that referenced this pull request Oct 24, 2015

Merge pull request #1234 from drewwells/feature/md

bb090ed

Convert wiki to markdown

xzyfer merged commit bb090ed into sass:master Oct 24, 2015

drewwells deleted the feature/md branch October 24, 2015 04:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert wiki to markdown #1234

Convert wiki to markdown #1234

drewwells commented May 21, 2015

coveralls commented May 21, 2015

ghost commented May 26, 2015

drewwells commented May 26, 2015

ghost commented May 26, 2015

drewwells commented May 26, 2015

xzyfer commented May 26, 2015

drewwells commented Sep 7, 2015

xzyfer commented Sep 7, 2015

drewwells commented Sep 18, 2015

drewwells commented Sep 18, 2015

una Oct 8, 2015

una Oct 8, 2015

una commented Oct 8, 2015

drewwells commented Oct 8, 2015

una commented Oct 8, 2015

charliepark Oct 8, 2015


		### Implementing libsass

		If you're interested in implementing libsass in your own project see the [API Documentation](api-doc.md) which now includes implementing


		## ABI forward compatibility

		We use a functional API to make dynamic linking more robust and future compatible. The API is not yet 100% stable, so we do not yet guarantee ABI forward compatibility. We will do so, once we increase the shared library version above 1.0.

Convert wiki to markdown #1234

Convert wiki to markdown #1234

Conversation

drewwells commented May 21, 2015

coveralls commented May 21, 2015

ghost commented May 26, 2015

drewwells commented May 26, 2015

ghost commented May 26, 2015

drewwells commented May 26, 2015

xzyfer commented May 26, 2015

drewwells commented Sep 7, 2015

xzyfer commented Sep 7, 2015

drewwells commented Sep 18, 2015

drewwells commented Sep 18, 2015

una Oct 8, 2015

Choose a reason for hiding this comment

una Oct 8, 2015

Choose a reason for hiding this comment

una commented Oct 8, 2015

drewwells commented Oct 8, 2015

una commented Oct 8, 2015

charliepark Oct 8, 2015

Choose a reason for hiding this comment