Obligatory post; documentation was mentioned.
It's looking like you guys will have real documentation now. Ondra is my hero
Search found 7 matches
- Mon Nov 09, 2015 10:39 pm
- Forum: News
- Topic: Friday Facts #111 - Long term plans
- Replies: 93
- Views: 68921
- Sun Oct 04, 2015 2:02 pm
- Forum: News
- Topic: Friday Facts #105 - The Grey Zone
- Replies: 48
- Views: 44816
Re: Friday Facts #105 - The Grey Zone
they think, they have to make ONE documentation. Yes, it's important to note that there are many different types of documentation. What we're talking about here is mostly Reference Documentation (since that's the only type of documentation that can be auto-generated). This is the documentation that...
- Sun Oct 04, 2015 3:50 am
- Forum: News
- Topic: Friday Facts #105 - The Grey Zone
- Replies: 48
- Views: 44816
Re: Friday Facts #105 - The Grey Zone
So how would you split the documentation up? Certainly it can't all be just one page, that would get super-messy. On the other hand, you feel that the current way of splitting it is too much. Many popular libraries use the single-page approach with very good effect. The single-page style can make d...
- Sat Oct 03, 2015 10:37 pm
- Forum: News
- Topic: Friday Facts #105 - The Grey Zone
- Replies: 48
- Views: 44816
Re: Friday Facts #105 - The Grey Zone
I agree that good code is extremely important, but I believe that good docs are needed as well. Not every little thing needs to be documented, that's definitely more effort than it's worth, but the functions and objects exposed to the public need to be explained properly. At this point, this is just...
- Sat Oct 03, 2015 1:56 pm
- Forum: News
- Topic: Friday Facts #105 - The Grey Zone
- Replies: 48
- Views: 44816
Re: Friday Facts #105 - The Grey Zone
What counts in the end is running code. Not text. I completely disagree. If you rely on code as documentation, it makes it even more difficult to learn about. Sure, it's more "accurate", as you say, but there's a much higher learning curve to it as well. The point of documentation is to m...
- Sat Oct 03, 2015 12:06 am
- Forum: News
- Topic: Friday Facts #105 - The Grey Zone
- Replies: 48
- Views: 44816
Re: Friday Facts #105 - The Grey Zone
Did you take a look at this? https://forums.factorio.com/wiki/index.php?title=Lua_objects Yes, that was part of the "very frustrating" comment. A wiki is not a good place for documentation. From the perspective of someone trying to get into modding (ie. knows nothing about the API, like m...
- Wed Sep 30, 2015 10:19 pm
- Forum: News
- Topic: Friday Facts #105 - The Grey Zone
- Replies: 48
- Views: 44816
Re: Friday Facts #105 - The Grey Zone
auto-generating the Lua API documentation This is by far the most exciting (to me) issue mentioned in the Friday Fact; when might we actually see it in a roadmap? I wanted to get into modding, but the current state of the documentation made it very frustrating. The only decent way to learn how thin...