[idea] Documentation in Markdown (not in PDF)

[ghost]

@IsaacShelton

I think that if you want to write documentation for Adept, you can do this in Markdown style in docs/*.md or GitHub wiki (not in PDF, like for Adept 2.3). What do you think about that?

NOTE: I think that documentation in Markdown is better that PDF documentation because of text styling.

[IsaacShelton]

@t0md3an I think this could be a good, I'll look into it

[SeekingMeaning]

@IsaacShelton Hello, would you like help with this? And if so, do you have any pointers on getting started?

[IsaacShelton]

@SeekingMeaning

I would love help with this!

To get started, you'll need a copy of the Adept 2.3 Language Spec which you can find here or under releases.

You can clone the wiki git clone https://github.com/IsaacShelton/Adept.wiki.git

You can see the current state of the Adept 2.4 documentation here

Github currently doesn't allow direct wiki contributions, so you'll have to make your own repo to push changes to. Once you've made additions, you can send me a link to your repo and I'll merge the changes into the main wiki!

Adept isn't very well documented right now, but the areas that have seen little to no change between Adept 2.3 and Adept 2.4 are these sections:

• Comments
• Function Pointers
• Pragma Directives
• Meta Directives

Documenting any these is probably the easiest place to start. The PDF is long, so ctrl-f is your friend.

[SeekingMeaning]

Is something like this good for Meta Directives? https://gist.github.com/SeekingMeaning/8eea2aced66425c388090f7122eaefbd

Or do you want it to be like Pragma Directives where each directive has its own page?

[IsaacShelton]

@SeekingMeaning It's good

There's not much information on each directive anyway, so having them all combined works well.

[IsaacShelton]

This is finished now 🎉