Only one Index.md for whole Project

[TobiasP541]

Hello :-)
Is there a possibility to just create one Index.md for the whole project?
Current Version looks like this
/doc
/doc/Object1Dir/index.md

• Contains md files for function summarys
  /doc/Object2Dir/index.md
• Contains md files for function summarys
  /doc/Object3Dir/index.md
• Contains md files for function summarys
  I want to create a folder structure like this

/doc
/doc/Object1Dir/

• Contains md files for function summarys
  /doc/Object2Dir/
• Contains md files for function summarys
  /doc/Object3Dir/
• Contains md files for function summarys
  /doc/index.md (Navigation to every function summary md file

Example

[spookymattress]

I vote for this enhancement as well!! 😜

[sirhc101]

We're currently working on the newest version, including the completely re-designed documentation markdown export. We added this enhancement to our backlog and will allow configuration to select creating one index file per project, per file or both.

Stay tuned, we plan to release the new version in next 2 weeks.

[sirhc101]

Hello @spookymattress & @MacWin77,

We've now our first beta version up and running and started some discussion in the team regarding the structure of the documentation (md) files generated. Current state is following:

• Each AL Object result in one markdown file, named like the AL file. This file includes the object description and each procedure, including params, obsolete reason, etc.
  
  
  Looks like this:
  
• Additionally per project one index.md file is created, including the app details from app.json (version, description, publisher, dependencies) and a grouped list of all objects. If an object description is present this will directly be printed below the object name. The object is linked to the specific AL Object markdown file.
  
  Currently looks like this:
  

Now, while we discussed this in the team the original idea of creating one file per project, per object and per procedure came back. Because you guys asked for it ... what do you think?
File per project (index), object (index) and procedure
vs.
File per project (index) and object including all procedures

Thank you very much.

[spookymattress]

In daily use and for small-medium sized projects I think I would go for File per project (index) and object including all procedures

But in large projects it could be nice to do:
File per project (index), object (index) and procedure

Could it be a config option you could set yourself?

[sirhc101]

@spookymattress Thank you. Yes, this are the same arguments which come into my mind. In large projects with APIs and stuff it's much more transparent. I will introduce a specific configuration for this.

[spookymattress]

Cool, any idea when the new release will be available?

[sirhc101]

We're planning to release version 1.1.0 on April 16th.

From our backlog we have all but two work items finished and completely tested, so I think we're in plan.